Lire un segment par code

Prod Env

https://relay.exostack.cloud/{{relay_path}}

GET

/api/inventory/segments/{code}

Retourne la fiche complète d'un segment à partir de son code numérique. Disponible aussi par ID via /by-id/{id}.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Responses

🟢200

application/json

Fiche complète du segment

Body

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://relay.exostack.cloud//api/inventory/segments/' \
--header 'x-api-key: <api-key>'

Response Example

{
    "id": 5,
    "code": 1,
    "name": "Couleur",
    "category_count": 3,
    "categories": [
        {
            "line_index": 1,
            "category_id": 10,
            "category_code": "ROUGE"
        },
        {
            "line_index": 2,
            "category_id": 11,
            "category_code": "BLEU"
        }
    ],
    "status": {
        "is_used": true,
        "is_deleted": false,
        "is_active": true
    },
    "metadata": {
        "updated_at": "2026-03-05T10:00:00-05:00",
        "updated_by_user_id": 1,
        "unique_id": 500,
        "sdk_interface": "Segment",
        "sdk_index_used": 1
    },
    "sync": {
        "organisation_id": "mastodonte",
        "extracted_at": "2026-03-13T10:00:00-04:00",
        "cursor": {
            "modified_at": "2026-03-05T10:00:00-05:00",
            "card_pos": 5
        }
    }
}

Modified at 2026-03-17 18:36:59

Supprimer un segment par ID

Modifier un segment par code