Skip to main content
GET
/
v1
/
contact-suggestions
List Contact Suggestions
curl --request GET \
  --url http://api.stuut.ai/v1/contact-suggestions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "email": "<string>",
      "object": "<string>",
      "partner_id": "<string>",
      "reason": "<string>",
      "source": "<string>",
      "suggestion_type": "add",
      "id": "<string>",
      "contact_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "external_contact": {
        "domain": "<string>",
        "email": "<string>",
        "object": "<string>",
        "source": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "family_name": "<string>",
        "given_name": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "phone": "<string>",
        "role": "<string>",
        "source_provider_id": "<string>",
        "status": "pending"
      },
      "external_contact_id": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "status": "pending"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:50

The page size

Required range: 1 <= x <= 200
sort_order
enum<string>
Available options:
asc,
desc
sort_by
string
partner
string
required

The Partner identifier, (e.g. ptn_abc123).

Response

Successful response

data
object[]