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-272",
      "type": "search_results",
      "attributes": {
        "result_type": "project"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "272"
          }
        }
      }
    },
    {
      "id": "person-1337",
      "type": "search_results",
      "attributes": {
        "result_type": "person"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1337"
          }
        }
      }
    },
    {
      "id": "person-1338",
      "type": "search_results",
      "attributes": {
        "result_type": "person"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1338"
          }
        }
      }
    },
    {
      "id": "company-1782",
      "type": "search_results",
      "attributes": {
        "result_type": "company"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1782"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "272",
      "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,
        "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,
        "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": 575
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1784"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1338"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1337",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1290@email.com",
        "title": null,
        "joined_at": "2020-08-11T01:05:31.000+02:00",
        "last_seen_at": "2020-08-11T01:05:31.922+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:31.854+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1782"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1338",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1291@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-08-11T01:05:31.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:31.876+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1783"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1782",
      "type": "companies",
      "attributes": {
        "name": "Organization575",
        "default_currency": "USD",
        "created_at": "2020-08-11T01:05:31.853+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1784",
      "type": "companies",
      "attributes": {
        "name": "Client1210",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:31.893+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1783",
      "type": "companies",
      "attributes": {
        "name": "Client1209",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:31.872+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "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": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "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
      }
    }
  }
}

Get search
GET/api/v2/search


Generated by aglio on 10 Aug 2020