List - Crego APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

page_size

number

optional

page

number

optional

expand

string

optional

Example:

related_contact

created_at_after

string

optional

Example:

2025-05-12

created_at_before

string

optional

Example:

2025-05-19

contact

string

optional

Example:

01JVVJF3NTPY29SE2XQ7C5H0QA

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://preprod.api.crego.io/contacts/relations/?expand=related_contact&contact=01JVVJF3NTPY29SE2XQ7C5H0QA'

Responses

🟢200Success

application/json

Body

count

integer

required

total_pages

integer

required

current_page

integer

required

has_previous

boolean

required

has_next

boolean

required

previous_page

null

required

next_page

null

required

results

array[object (Relation) {9}]

required

contact

string

required

Unique identifier for the contact, must be alphanumeric or UUID

type

enum<string>

required

Relationship type between the contact and related contact

Allowed values:

fathermotherspousechildsiblingfriendco_applicantguarantorwitnessnominee

related_contact

string | null

optional

Unique identifier for the related contact, must be alphanumeric or UUID

id

string

optional

ID, 8-40 characters long, allowing alphanumeric characters.

>= 8 characters<= 40 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

created_at

string <date-time>

optional

Timestamp indicating when the entity was created, in ISO 8601 format.

created_by

string

optional

Created by, 1-100 characters long, allowing alphanumeric characters, spaces, periods, underscores, and dashes.

<= 100 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

updated_at

string <date-time>

optional

Timestamp indicating when the entity was last updated, in ISO 8601 format.

updated_by

string | null

optional

Updated by, 1-100 characters long, allowing alphanumeric characters, spaces, periods, underscores, and dashes.

<= 100 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

tenant_id

string

optional

Tenant ID, 6-40 characters long, allowing alphanumeric characters.

<= 40 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

Examples

Success with expandSuccess

[{"id":"01JN5QEYNNCEB2K4BRQJRNZGMG","tenant_id":"59ecf94e-054d-43ee-83db-b158ab9d7f67","created_by":"cffe818a-5003-4116-9104-069f7e062bb4","updated_by":"","created_at":"2025-02-28T13:01:16.341851Z","updated_at":"2025-02-28T13:01:16.341851Z","type":"father","contact":"01JMH5RK91QB2WKRE67D1F32YS","related_contact":{"id":"01JMH4QJQ6VP27A1ZSZ8YZ486K","tenant_id":"59ecf94e-054d-43ee-83db-b158ab9d7f67","created_by":"cffe818a-5003-4116-9104-069f7e062bb4","updated_by":"","created_at":"2025-02-20T13:09:07.494558Z","updated_at":"2025-02-20T13:09:07.494558Z","name":"Kaushik","status":"active","type":"individual","tags":["string"],"refs":{},"branch":null}}]