/lead-rotations/{rotationId}

GET /lead-rotations/{rotationId}

Get a lead rotation by ID

Retrieves a specific lead rotation by its ID. The user must have access to the account that owns the rotation.

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

rotationId path integer

The ID of the lead rotation to retrieve

Try it out

Output:

Responses

Description

Successful response

{
  "id": 0,
  "name": "string",
  "accountId": "string",
  "status": "string",
  "teamId": 0,
  "userRotationArray": [
    "string"
  ],
  "currentPosition": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "team": {
    "id": 0,
    "account_id": "string",
    "accountId": "string",
    "name": "string",
    "active": true,
    "members": [
      {
        "userId": 0,
        "email": "string",
        "name": "string"
      }
    ],
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/TeamMember #/components/schemas/Team #/components/schemas/LeadRotation

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/TeamMember

OpenAPI
TypeScript

type: object
description: User who is a member of a team
properties:
  userId:
    type: integer
    description: ID of the user
  email:
    type: string
    description: Email of the user
  name:
    type: string
    description: Name of the user
required:
  - userId
  - email

|
export interface TeamMember {
  /** ID of the user */
  userId: number;
  /** Email of the user */
  email: string;
  /** Name of the user */
  name?: string;
}

#/components/schemas/Team

OpenAPI
TypeScript

type: object
description: Team information
properties:
  id:
    type: integer
    description: Team ID
    readOnly: true
  account_id:
    type: string
    description: ID of the account that owns this team
  accountId:
    type: string
    description: ID of the account that owns this team
  name:
    type: string
    description: Team name
  active:
    type: boolean
    default: true
    description: Whether the team is active
  members:
    type: array
    items:
      $ref: "#/components/schemas/TeamMember"
    description: Users who are members of this team
  createdBy:
    type: string
    description: Email of the user who created the team
  updatedBy:
    type: string
    description: Email of the user who last updated the team
  createdAt:
    type: string
    format: date-time
    description: When the team was created
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    description: When the team was last updated
    readOnly: true
required:
  - name

|
export interface Team {
  /** Team ID */
  id?: number;
  /** ID of the account that owns this team */
  account_id?: string;
  /** ID of the account that owns this team */
  accountId?: string;
  /** Team name */
  name: string;
  /** Whether the team is active */
  active?: boolean;
  /** Users who are members of this team */
  members?: TeamMember[];
  /** Email of the user who created the team */
  createdBy?: string;
  /** Email of the user who last updated the team */
  updatedBy?: string;
  /** When the team was created */
  createdAt?: Date;
  /** When the team was last updated */
  updatedAt?: Date;
}

#/components/schemas/LeadRotation

OpenAPI
TypeScript

type: object
description: Lead rotation object representing a strategy for distributing leads among users
properties:
  id:
    type: integer
    description: Unique identifier for the lead rotation
  name:
    type: string
    description: Name of the lead rotation
  accountId:
    type: string
    description: ID of the account that owns this lead rotation
  status:
    type: string
    description: Status of the lead rotation
    enum:
      - active
      - archived
      - queued
  teamId:
    type: integer
    description: ID of the team associated with this lead rotation
  userRotationArray:
    type: array
    items:
      type: string
    description: Array of user emails in the rotation order
  currentPosition:
    type: integer
    description: Current position in the rotation array
  createdAt:
    type: string
    format: date-time
    description: When the lead rotation was created
  updatedAt:
    type: string
    format: date-time
    description: When the lead rotation was last updated
  createdBy:
    type: string
    description: Email of the user who created the lead rotation
  updatedBy:
    type: string
    description: Email of the user who last updated the lead rotation
  team:
    $ref: "#/components/schemas/Team"
required:
  - id
  - name
  - accountId
  - status
  - userRotationArray

|
export interface LeadRotation {
  /** Unique identifier for the lead rotation */
  id: number;
  /** Name of the lead rotation */
  name: string;
  /** ID of the account that owns this lead rotation */
  accountId: string;
  /** Status of the lead rotation */
  status: "active" | "archived" | "queued";
  /** ID of the team associated with this lead rotation */
  teamId?: number;
  /** Array of user emails in the rotation order */
  userRotationArray: string[];
  /** Current position in the rotation array */
  currentPosition?: number;
  /** When the lead rotation was created */
  createdAt?: Date;
  /** When the lead rotation was last updated */
  updatedAt?: Date;
  /** Email of the user who created the lead rotation */
  createdBy?: string;
  /** Email of the user who last updated the lead rotation */
  updatedBy?: string;
  team?: Team;
}

Route Source Code

Check out the source code for this route entrypoint here: /lead-rotations/[rotationId]/route.ts

Or the swagger.yaml spec this documentation was generated from: /lead-rotations/swagger.yaml