---
title: "Gets Customer Survey Segment by id"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed/operations/get-customersurveysegments-id"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed.md

# Gets Customer Survey Segment by id

`GET` `/customersurveysegments/{id}`

Operation ID: `get-customersurveysegments-id`

Gets Customer Survey Segment by id

## Path parameters

- `id` (integer, int32, required) - Format - int32. Customer Survey Segment id

## Header parameters

- `x-api-key` (string, required) - Api subscription key
- `Cache-Control` (string, optional)
- `Authorization` (string, required) - Bearer token for authorization (e.g., Bearer <token>)

## Responses

- `200` - Returns found Customer Survey Segment
- `400` - Bad request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - NotFound

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: V2
servers:
  - url: https://api.retailexpress.com.au/v2
paths:
  /customersurveysegments/{id}:
    get:
      tags:
        - customersurveysegments
      summary: Gets Customer Survey Segment by id
      description: Gets Customer Survey Segment by id
      operationId: get-customersurveysegments-id
      parameters:
        - name: id
          in: path
          description: Format - int32. Customer Survey Segment id
          required: true
          schema:
            type: integer
            description: Customer Survey Segment id
            format: int32
        - name: x-api-key
          in: header
          description: Api subscription key
          required: true
          schema:
            type: string
        - name: Cache-Control
          in: header
          required: false
          schema:
            type: string
            default: no-cache
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authorization (e.g., Bearer <token>)
          schema:
            type: string
      responses:
        "200":
          description: Returns found Customer Survey Segment
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CustomerSegmentGroup"
              example:
                id: 0
                name: string
                active: true
                options:
                  - id: 0
                    name: string
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProblemDetails"
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProblemDetails"
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProblemDetails"
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        "404":
          description: NotFound
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProblemDetails"
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
security: []
components:
  schemas:
    CustomerSegmentGroup:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Customer Segment Group Identifier
          format: int32
        name:
          type: string
          description: Name
          nullable: true
        active:
          type: boolean
          description: Active status
        options:
          type: array
          items:
            $ref: "#/components/schemas/CustomerSegmentOption"
          description: Customer segment options
          nullable: true
      additionalProperties: false
      description: Customer segment group model
    ProblemDetails:
      title: ""
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    CustomerSegmentOption:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Customer segment option identifier
          format: int32
        name:
          type: string
          description: Customer segment option name
          nullable: true
      additionalProperties: false
      description: Customer segment option model
```