Search Contacts

Description

This endpoint provides a list of contacts.

Endpoint

/v1/contacts/search

Request parameters

Responses

{
  "data": [
    {
      "createdDate": "2025-08-13T19:17:25.998Z",
      "modifiedDate": "2025-08-13T19:17:25.998Z",
      "entityId": "2ed74b9f-6945-468c-8faf-d0652ff52069",
      "firstName": "Mickey",
      "lastName": "Mouse",
      "studioId": "83361967-44bc-426e-ac21-080e585440f3"
    }
  ],
  "meta": {
    "query": "query: Mickey, studioId: [83361967-44bc-426e-ac21-080e585440f3]",
    "pageNumber": 1,
    "totalElements": 1,
    "limit": 20,
    "offset": 0
  }
}

Examples

Description	Example Request
Search	`/v1/contacts/search`
Search by First Name	`/v1/contacts/search?query=Mickey`
Search by Last Name	`/v1/contacts/search?query=Mouse`
Search by Email	`/v1/contacts/search?query=mickey.mouse@disney.com`
Search by Studio IDs	`/v1/contacts/search?studioId=e806110e-1ffe-4cbf-a6ef-fbccd18740fd`
Search by Studio IDs and First Name	`/v1/contacts/search?studioId=e806110e-1ffe-4cbf-a6ef-fbccd18740fd&query=Mickey`
Search by Studio IDs and Last Name	`/v1/contacts/search?studioId=e806110e-1ffe-4cbf-a6ef-fbccd18740fd&query=Mouse`
Search by Studio IDs and Email	`/v1/contacts/search?studioId=e806110e-1ffe-4cbf-a6ef-fbccd18740fd&query=mickey.mouse@disney.com`

Get Studios: Retrieve valid studio IDs for searching contacts.
Create Contact: Create a new contact if not found in search.
Update Contact: Update an existing contact.
Create Contract: Use a contact as talent in a contract.
API Reference: See all available endpoints and details.

24 November 2025

Search Contacts

Description

Endpoint

Request parameters

Responses

Examples

Related Documentation