Manage clients for your company. In the Spectora data model, a client record is referred to as a 'contact' — it represents the link between a buyer/client and your company. The API routes and field names use 'contact' terminology (and 'buyer' for the global client record), but conceptually these are your clients.
List clients
Returns a paginated list of clients for your company. In Spectora's data model, a client record is called a 'contact' — it represents the link between a buyer/client and your company. The API routes and field names use 'contact' terminology (and 'buyer' for the global client record), but conceptually these are your clients.
query Parameters
page[number]Page number (starts at 1)
page[size]Number of records per page (default: 200, max: 200)
filter[id]Filter by client ID (the contact ID for this client in your company)
filter[buyer_id]Filter by the client's global ID (internally called 'buyer ID'), shared across companies
filter[fulltext]Full-text search across client name and associated user details
filter[tag]Filter by tag name(s). Can be a single tag or an array of tags.
sortSort field. Prefix with '-' for descending order. Available fields: first_name, last_name, last_first_name
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List clients › Responses
Clients retrieved successfully
Pagination metadata
Pagination links
Create a client
Creates a new client for your company. In Spectora's data model, a client record is called a 'contact' and the global client record is called a 'buyer'. The request body uses 'contact' field names. At least one of email, phone, or first_name must be provided. If an email is provided and a buyer (global client record) with that email already exists, the contact will be linked to the existing buyer.
When including an image change the body to Multipart and pass data in key value entries with the key formatted as data[attributes][field-name]. For the images specifically use data[attributes][image] and include the image file as the value. Supported image file types are: .jpg, .jpeg, .png, and .gif.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Content-TypeCreate a client › Responses
Client created successfully
Get a client
Returns detailed information about a specific client. In Spectora's data model, a client record is called a 'contact'. The {id} path parameter is the contact ID for this client in your company.
path Parameters
idClient ID (the contact ID for this client in your company)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get a client › Responses
Client retrieved successfully
Update a client
Updates an existing client for your company. All fields are optional — only provided fields will be updated. Note: the client's email cannot be changed via this endpoint. In Spectora's data model, a client record is called a 'contact'.
When including an image change the body to Multipart and pass data in key value entries with the key formatted as data[attributes][field-name]. For the images specifically use data[attributes][image] and include the image file as the value. Supported image file types are: .jpg, .jpeg, .png, and .gif.
path Parameters
idClient ID (the contact ID for this client in your company)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Content-TypeUpdate a client › Responses
Client updated successfully