Skip to content

Get All Deal Ids

Returns an array of all deal IDs accessible to the authenticated user. This lightweight endpoint is useful for syncing deal lists or batch operations.

Key Details

  • No parameters required — simply returns all deal IDs the authenticated user has access to.
  • Response contains only the deal IDs (dealIds array) — use Get Deal Info to retrieve detailed information for each deal.
  • All deal IDs are UUIDs (e.g., a1b2c3d4-5678-9012-abcd-ef0123456789).
  • Useful as the first step in a batch workflow: fetch all IDs, then retrieve specific deal details as needed.

Response

Status: 200

Type: application/json

Schema: DealIdsResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto
target string

Field or parameter that caused the error

code string(enum)

Error code (e.g., Duplicated, MissingMandatoryField, InvalidCreateValues, MissingEntity)

Available enum values: Duplicated, MissingMandatoryField, InvalidCreateValues, Existing, ValidationError, MissingEntity

message string

details array [ ErrorDto ]
dealIds array [ string ]

List of all accessible deal IDs

GET 
/api/apiGateway/getAllDealIds
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  },
  "dealIds": [
    "string"
  ]
}