Organization Folders

List Organization Folders

Returns active folders for the authenticated organization with optional search and pagination.

get/v1/organization-folders

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/organization-folders
  • Auth: HTTP bearer

Query parameters

searchstring
Example:Call

Search by folder name

pagestring
Example:1

Page number, starting from 1. Default 1. Read with parseInt, so 2.5 or 2abc is page 2; a value that does not start with a number, or is below 1, returns 400.

limitstring
Example:20

Folders per page, from 1 to 50. Default 20. Read with parseInt, so 10.5 is 10; a value that does not start with a number, or is outside 1 to 50, returns 400.

exportboolean
Example:true

Accepted for compatibility but ignored: results are always paginated.

Response

Organization folders returned successfully.

successtrue required
errorfalse required
statusCodeinteger required
messagestring required
timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "folders": [
      {
        "id": "f5k2m8x1q9w3zp",
        "organization_id": "o14XKPP84rt22g",
        "name": "Sales Agents",
        "organization": {
          "id": "o14XKPP84rt22g",
          "title": "Acme Lending"
        },
        "agentCount": 3
      }
    ],
    "page": 1,
    "limit": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.