Get Custom Sources

GET

https://platform-api.convirza.com/v3/custom-source

Custom Source

Last modified:2026-07-24 13:10:44

Returns all custom sources with optional filtering.

Filtering Options

org_unit_id — (required) organization unit ID to filter by.

filter — filter query using format "field=value" or "field!=value".

Supported fields: custom_source_id, custom_source_name, custom_source_type, org_unit_id

Example: "custom_source_type=CS1" or "custom_source_id!=123"

limit — maximum number of records to return (default: 10, min: 1, max: 200).

offset — number of records to skip for pagination (default: 0, min: 0).

sort_by — field to sort by (custom_source_name, custom_source_type) - default: custom_source_name.

sort_order — sort direction (asc, desc) - default: asc.

Response
Each custom source record includes:

Custom source ID, name, type

Organization unit ID

Example Request

GET /custom-source?org_unit_id=1001&filter=custom_source_type=CS1&limit=50

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Successfully retrieved custom sources

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/custom-source?org_unit_id=&filter=&limit=&offset=&sort_by=&sort_order=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "custom_sources": [
            {
                "custom_source_id": 123,
                "custom_source_name": "ABC",
                "custom_source_type": "CS1",
                "org_unit_id": 70035
            }
        ],
        "total": 4,
        "limit": 50,
        "offset": 0
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

Delete Custom Insight

Create Custom Source