Search ledger contacts

post

https://gotlivedata.io/api/ledger/v2/orgs/{org_id}/ledgers/{ledger_id}/contacts/search

Search contacts in the specified ledger using a variety of filters, sorting, and pagination.

This call returns JSON data -- for a CSV download using the same filters, see POST .../contacts/search/download.

Role(s) permitted: viewer, editor, admin

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

ledger_id

string

required

The ID of the ledger

org_id

string

required

The ID of the org

Body Params

Body to provide when searching contacts in a ledger. It consists of some basic search criteria such as which fields to return, sorting, and pagination, and a list of filters to apply in the search.

filters

array of objects

filters

return_fields

array of strings

List of the fields to return. If not provided, return all fields.

Field names match the names in the Contact object. Nested object field names are specified using dot-notation, such as position.company.name.

return_fields

view

string

enum

Defaults to data

The view of the report that you want returned: data (default) - returns all of the data that matches the search criteria count - returns only the count of items that match the search criteria

Allowed:

sort_by

string

Which field to sort on. Use the pattern +name to sort ascending and -name to sort descending.

size

integer

Number of records to return. Use to improve performance for large ledgers.

Ignored in the /download endpoint, which always downloads all records.

pagination_token

string

If provided, returns the next page of data based on the pagination_token.

The pagination_token is only valid for a given set of filters/size -- the same filters and size must be supplied for every call using the pagination_token from a response with those filters. If the filters/size don't match the pagination_token, this call will return a 400.

Responses

400

Bad Request Can happen if the request body sent with a pagination_token doesn't match the request body that generated the pagination_token

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK