API Documentation

API Endpoint
GET /api/v2/search
Requestsreturns search results

GET  /api/v2/search?filter[query]=a

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "project-1360",
      "type": "search_results",
      "attributes": {
        "result_type": "project"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1360"
          }
        }
      }
    },
    {
      "id": "person-4854",
      "type": "search_results",
      "attributes": {
        "result_type": "person"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "4854"
          }
        }
      }
    },
    {
      "id": "person-4855",
      "type": "search_results",
      "attributes": {
        "result_type": "person"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "4855"
          }
        }
      }
    },
    {
      "id": "company-7186",
      "type": "search_results",
      "attributes": {
        "result_type": "company"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "7186"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1360",
      "type": "projects",
      "attributes": {
        "name": "abc",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-07-24T01:10:43.108+02:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "7188"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "4855"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4854",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4790@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:10:43.000+02:00",
        "last_seen_at": "2021-07-24T01:10:43.136+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 4830,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:10:43.048+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "7186"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4855",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4791@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:10:43.000+02:00",
        "is_user": true,
        "user_id": 4831,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:10:43.079+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "7187"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "7186",
      "type": "companies",
      "attributes": {
        "name": "Organization1335",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:10:43.047+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "7188",
      "type": "companies",
      "attributes": {
        "name": "Client5863",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:10:43.106+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "7187",
      "type": "companies",
      "attributes": {
        "name": "Client5862",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:10:43.075+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1335
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get search
GET/api/v2/search


Generated by aglio on 23 Jul 2021