Collect API documentation

List all contacts

GET /contacts

Retrieve all contacts shared by the team

Query parameters

offset integer

Ranking number of the first item on the page
limit integer

Number of results to return

Maximum value is 100. Default value is 50.
sort string

Specify how to sort the results

Values are fnAsc, fnDesc, lnAsc, lnDesc, emAsc, emDesc, tagAsc, or tagDesc.
search string

String to look up. It will look up into email, first name, last name, and custom attributes. Will return partial matches.
email string

Email address you want to look up. This search is an exact match and is case-sensitive.
firstname string

First name you want to look up. This search is an exact match and is not case-sensitive.
lastname string

Last name you want to look up. This search is an exact match and is not case-sensitive.

Responses

• 200 application/json

Success
Hide response attributes Show response attributes object
- _id string
- email string(email)
- firstName string
- lastName string
- company string
- tag array[string]
- custom array[object]
  
  Hide custom attributes Show custom attributes object
  
  _id string
  
  name string
  
  variable string
  
  value string
• 400

Bad Request -- Your request is invalid.
• 401

Unauthorized -- Your API key is wrong.
• 403

Forbidden -- The object requested is hidden for administrators only.
• 404

Not Found -- The specified object could not be found.
• 429

Too Many Requests -- You're requesting too many objects! Slow down!
• 500

Internal Server Error -- We had a problem with our server. Try again later.
• 503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

GET /contacts

curl \
 -X GET https://api.usecollect.com/v1/contacts \
 --user "username:password"

Response examples (200)

[
  {
    "_id": "uBJadNFcjrC6emRom",
    "email": "johndoe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "tag": [
      "Speaker"
    ],
    "custom": [
      {
        "_id": "yw6XDyeFvbqr86yA6",
        "name": "Favorite color",
        "variable": "color",
        "value": "Blue"
      },
      {
        "_id": "CqdFwGX3yitk9zf8z",
        "name": "Country",
        "variable": "country",
        "value": "US"
      }
    ]
  }
]