top of page

Store Audit Cycle

API endpoint to get information about Store Audit Cycle entities

Retrieve Store Audit Cycle data 

GET

GET /api/:version_number/:project_name/entity/audit_cycle_sets?:pagination_params

curl -K -H "Authorization: Auth-Token YOUR_PROJECT-API-KEY" https://services.traxretail.com/api/v4/my-project/entity/audit_cycle_sets?sort=audit_cycle_name&page=1&per_page=10

Supported Protocol: HTTPS

{

"metadata": {

"page": 2,

"per_page": "10",

"page_count": 1167,

"total_count": 11668,

"links": {

"self": "/api/v4/my-project/entity/

user?sort=email_address&

page=1&per_page=10",

 

"first": "/api/v4/my-project/entity/

user?sort=email_address&

page=0per_page=10",

 

"previous": "/api/v4/my-project/

    entity/user?

    sort=email_address&

page=0&per_page=10",

 

"next": "/api/v4/my-project/entity/user

?sort=email_address&page=2

&per_page=10",

 

"last": "/api/v4/my-project/entity/user

?sort=email_address&page=1

166&per_page=10",

}

},

"users": [

{

"login_name": "ford@example.com",

"email_address": "ford@example.com",

"mobile_number":"+15417543010",

"first_name": "Henry",

"last_name": "Ford",

"is_deleted": false,

"supervisors_username": "john@example.com",

"operational_role": "Sales Rep",

"entities": {

"routes": [ "CB1" ]

}

},

{

"login_name": "john@example.com",

"email_address": "john@example.com",

"first_name": "John",

"last_name": "Doe",

"is_deleted": false,

"operational_role": "Supervisor",

"entities": {

"routes": [ "A365" ]

}

},

{

"login_name": "sally@example.com",

"email_address": "sally@example.com",

"first_name": "Sally",

"last_name": "Housecoat",

"is_deleted": false,

"operational_role": "Sales Rep",

"entities": {

"routes": []

}

},

{

"login_name": "+447813988839",

"mobile_number": "+447813988839",

"first_name": "John",

"last_name": "Smith",

"is_deleted": false,

"operational_role": "Manager",

"entities": {

"routes": ["route_A"]

}

},

{

"login_name": "smith@example.com",

"email_address": "smith@example.com",

"first_name": "Dana",

"last_name": "Scully",

"is_deleted": false,

"operational_role": "Auditor",

"entities": {

"stores": ["100","200","300"]

}

}]

}

Response

bottom of page