Retrieve - Crego APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

contact_address_id

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

contact_id

string

required

address_line

string

optional

Address line containing 5-100 characters, allowing letters, numbers, spaces, and common symbols (,.'-/#).

Match pattern:

^[a-zA-Z0-9\s,.'\-\/#]{5,100}$

city

string

optional

City name containing 2-50 characters, allowing letters, spaces, dashes, and periods.

Match pattern:

^[a-zA-Z\s-.]{2,50}$

state

string

optional

State name containing 3-50 characters, allowing letters, spaces, and dashes.

>= 3 characters<= 50 characters

Match pattern:

^[a-zA-Z\s-]{3,50}$

pincode

string

optional

6-digit numeric postal code.

Match pattern:

^[0-9]{6}$

country

string

optional

Country name containing 2-50 characters, allowing only letters and spaces.

Match pattern:

^[a-zA-Z\s]{2,50}$

coords

object

optional

Location coordinates

lat

number

required

Latitude of the location.

long

number

required

Longitude of the location.

codes

object

optional

Object to hold miscellaneous codes.

tags

array[string]

optional

Array of tags, each containing 1-50 characters, allowing letters, numbers, spaces, and dashes.

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}$

Example

{
    "contact_id": "string",
    "address_line": "string",
    "city": "string",
    "state": "string",
    "pincode": "string",
    "country": "string",
    "coords": {
        "lat": 0,
        "long": 0
    },
    "codes": {},
    "tags": [
        "string"
    ],
    "id": "stringst",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "updated_by": "string",
    "tenant_id": "string"
}