Approved Travel (get) - R24 External Partner APIs

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

org_id

string <uuid>

required

Organization / Tenant ID

Example:

f0ed3212-0b64-28b0-2ec2-3c3e536d010a

source_system_id

string <uuid>

required

The distinct identifier of the partner system tasked with supplying this data

requested_travel

object (Travel Request )

required

source_system_ref

string

required

The distinctive reference number for this record within the partner system

>= 8 characters

Example

{
    "org_id": "f0ed3212-0b64-28b0-2ec2-3c3e536d010a",
    "source_system_id": "b5e2a196-42e8-5f47-f884-b90f68b0b3a1",
    "requested_travel": [
        {
            "source_system_ref": "d8fd07cf-8a0f-5341-59a9-e323c6beb30b"
        },
        {
            "source_system_ref": "54e1b8d0-38c0-bf97-0ab9-cc5d8447476d"
        },
        {
            "source_system_ref": "5718d26a-3b89-e584-607d-919c34b2fd55"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://dev.your-api-server.com/approved_travel' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "org_id": "f0ed3212-0b64-28b0-2ec2-3c3e536d010a",
    "source_system_id": "b5e2a196-42e8-5f47-f884-b90f68b0b3a1",
    "requested_travel": [
        {
            "source_system_ref": "d8fd07cf-8a0f-5341-59a9-e323c6beb30b"
        },
        {
            "source_system_ref": "54e1b8d0-38c0-bf97-0ab9-cc5d8447476d"
        },
        {
            "source_system_ref": "5718d26a-3b89-e584-607d-919c34b2fd55"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

array of:

user_email

string <email>

required

Email address of the user

travel_status

enum<integer> <int32>

Travel Status

required

The current state of the travel.

Allowed values:

0123

departure_address

string

required

Departure Address

Example:

2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU

departure_country_code

string

required

Depature Country (code 3)

Example:

GBR

departure_latitude

number <double>

required

Departure Latitude

Example:

51.231380271453126

departure_longitude

number <double>

required

Departure Longitude

Example:

0.2124915109713824

departure_datetime

string <date-time>

date-time

required

Expected Departure Date and Time (format: YYYY-MM-DDThh:mm:ssZ)

Example:

YYYY-MM-DDThh:mm:ssZ

destination_address

string

required

Destination Address

Example:

45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055

destination_country_code

string

required

Destination Country (code 3)

Example:

ZAF

destination_latitude

number <double>

required

Destination Latitude

Example:

-26.026765138629315

destination_longitude

number <double>

required

Destination Longitude

Example:

28.007101310304233

arrival_datetime

string <date-time>

date-time

required

Expected Arrival Date and Time (format: YYYY-MM-DDThh:mm:ssZ)

Example:

YYYY-MM-DDThh:mm:ssZ

checkin_status

enum<integer> <int32> | enum<null>

Check-In Status

optional

Check-In Status

Allowed values:

012

checkin_datetime

string <date-time> | null

optional

Check-In Date and Time (format: YYYY-MM-DDThh:mm:ssZ)

source_system_ref

string

required

The distinctive reference number for this record within the partner system

>= 8 characters

Example

[
    {
        "user_email": "Jedidiah.Dickinson@yahoo.com",
        "travel_status": 0,
        "departure_address": "2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU",
        "departure_country_code": "GBR",
        "departure_latitude": 51.231380271453126,
        "departure_longitude": 0.2124915109713824,
        "departure_datetime": "2025-05-19 13:25:52.700605",
        "destination_address": "45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055",
        "destination_country_code": "ZAF",
        "destination_latitude": -26.026765138629315,
        "destination_longitude": 28.007101310304233,
        "arrival_datetime": "2025-05-20 11:25:52.700605",
        "checkin_status": 0,
        "checkin_datetime": null,
        "source_system_ref": "d8fd07cf-8a0f-5341-59a9-e323c6beb30b"
    },
    {
        "user_email": "Noemie.Turner@hotmail.com",
        "travel_status": 1,
        "departure_address": "2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU",
        "departure_country_code": "GBR",
        "departure_latitude": 51.231380271453126,
        "departure_longitude": 0.2124915109713824,
        "departure_datetime": "2025-04-19 13:25:52.700605",
        "destination_address": "45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055",
        "destination_country_code": "ZAF",
        "destination_latitude": -26.026765138629315,
        "destination_longitude": 28.007101310304233,
        "arrival_datetime": "2025-04-20 11:25:52.700605",
        "checkin_status": 0,
        "checkin_datetime": null,
        "source_system_ref": "54e1b8d0-38c0-bf97-0ab9-cc5d8447476d"
    },
    {
        "user_email": "Noemie.Turner@hotmail.com",
        "travel_status": 2,
        "departure_address": "2 Nizels Knoll, Nizels Lane, Hildenborough, Kent, UK, TN11 8NU",
        "departure_country_code": "GBR",
        "departure_latitude": 51.231380271453126,
        "departure_longitude": 0.2124915109713824,
        "departure_datetime": "2025-04-01 13:25:52.700605",
        "destination_address": "45 Kingfisher Dr, Fourways, Sandton, Johannesburg, 2055",
        "destination_country_code": "ZAF",
        "destination_latitude": -26.026765138629315,
        "destination_longitude": 28.007101310304233,
        "arrival_datetime": "2025-04-02 11:25:52.700605",
        "checkin_status": 1,
        "checkin_datetime": "2025-04-02 11:45:52.700605",
        "source_system_ref": "5718d26a-3b89-e584-607d-919c34b2fd55"
    }
]

🟠400Bad Request

🟠401Unauthorized