Get a lead segment

GET /lead-segments/{id}
OAuth2

Get a lead segment by its ID

Headers

  • Authorization string

    Bearer token used for authorization

    Minimum length is 1.

  • X-Correlation-Id string

    Unique identifier to allow referencing a particular transaction or event chain

    Minimum length is 1.

Path parameters

  • id string Required

    Primary identifier of the requested resource

    Minimum length is 1.

Responses

  • 200 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data object Required

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • id string Required

        Minimum length is 1.

      • description string | null

        Repeat visitor

        Minimum length is 1.

      • code string Required

        REPEATVISITOR

        Minimum length is 1, maximum length is 255.

      • createdAt string(date-time) Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.

      • deletedAt string(date-time) | null Required

        Minimum length is 1.
  • 404 application/json

    Resource not found

    Hide response attribute Show response attribute object
    • errors array[object] Required

      At least 1 element.

      Hide errors attributes Show errors attributes object
      • message string Required

        Minimum length is 1.

      • code string Required

        Minimum length is 1.

      • type string Required

        Minimum length is 1.

      • statusCode string Required

        Minimum length is 1.
GET /lead-segments/{id} 
curl \
 -X GET https://api.development.pexipengage.com/enterprises/acme/lead-segments/1234 \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": {
    "id": "123",
    "description": "string",
    "code": "string",
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z"
  }
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}