--- updatedAt: 2026-07-31T14:15:06.000Z agentTools: projectIndex: https://reference.fidel.uk/llms.txt --- # List Locations # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "fidel-api", "version": "1" }, "servers": [ { "url": "https://api.fidel.uk/v1" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Fidel-Key" } } }, "security": [ { "sec0": [] } ], "paths": { "/programs/{programId}/locations": { "get": { "summary": "List Locations", "description": "", "operationId": "list-locations", "parameters": [ { "name": "Content-Type", "in": "header", "description": "application/json", "required": true, "schema": { "type": "string" } }, { "name": "Fidel-Key", "in": "header", "description": "test/live API secret key.", "required": true, "schema": { "type": "string" } }, { "name": "programId", "in": "path", "description": "The program with the locations you wish to \"GET\"", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "description": "number of locations to return", "schema": { "type": "string", "default": "100" } }, { "name": "start", "in": "query", "description": "Tells the API where the previous response left off. Use ${encodeURIComponent(JSON.stringify(last))}, where \"last\" is the parameter from the previous query.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "possible values [asc, desc] of 'created' date", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "description": "4 - 20 characters.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "[active,syncing,failed]", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"count\": 1,\n \"items\": [\n {\n \"metadata\": {\n \"customKey2\": \"customValue2\",\n \"customKey1\": \"customValue1\"\n },\n \"currency\": \"USD\",\n \"visa\": {\n \"estimatedActivationDate\": null,\n \"clearingTransactionId\": null,\n \"auth\": false,\n \"authTransactionId\": null,\n \"clearing\": false,\n \"status\": \"active\"\n },\n \"geolocation\": {\n \"latitude\": 51.5138332,\n \"longitude\": -0.1318224\n },\n \"city\": \"New York\",\n \"mastercard\": {\n \"estimatedActivationDate\": null,\n \"clearingTransactionId\": null,\n \"auth\": false,\n \"authTransactionId\": null,\n \"clearing\": false,\n \"status\": \"active\"\n },\n \"programId\": \"b58d8057-9159-4daf-a003-1397e28f6822\",\n \"amex\": {\n \"estimatedActivationDate\": null,\n \"clearingTransactionId\": null,\n \"auth\": false,\n \"authTransactionId\": null,\n \"clearing\": false,\n \"status\": \"active\"\n },\n \"searchBy\": {\n \"merchantIds\": {\n \"mastercard\": [\n \"445566\",\n \"556677\"\n ],\n \"visa\": [\n \"445566\",\n \"556677\"\n ]\n }\n },\n \"id\": \"e8e44865-190b-46d0-9fcb-d23718cc6698\",\n \"preonboard\": false,\n \"postcode\": \"10036\",\n \"accountId\": \"3693ac7e-3e2b-432c-8c60-2b786453ca9b\",\n \"activeDate\": \"2020-08-19T17:21:36.327Z\",\n \"countryCode\": \"USA\",\n \"created\": \"2020-08-19T17:21:36.327Z\",\n \"address\": \"55 West 46th Street\",\n \"stateCode\": \"NY\",\n \"live\": false,\n \"updated\": \"2020-08-19T17:28:06.697Z\",\n \"brandId\": \"838d648e-5614-48a7-8e8b-6b3014638c66\",\n \"timezone\": \"America/New_York\",\n \"active\": true\n }\n ],\n \"last\": {\n \"programIdDel\": \"b58d8057-9159-4daf-a003-1397e28f68220\",\n \"created\": \"2020-03-14T09:19:39.431Z\",\n \"id\": \"cdca1e41-9577-41a8-8fa9-245592e23c68\"\n },\n \"resource\": \"/v1/programs/b58d8057-9159-4daf-a003-1397e28f6822/locations\",\n \"status\": 200,\n \"execution\": 450.340728\n}" } }, "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "default": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "customKey2": { "type": "string", "example": "customValue2" }, "customKey1": { "type": "string", "example": "customValue1" } } }, "currency": { "type": "string", "example": "USD" }, "visa": { "type": "object", "properties": { "estimatedActivationDate": {}, "clearingTransactionId": {}, "auth": { "type": "boolean", "example": false, "default": true }, "authTransactionId": {}, "clearing": { "type": "boolean", "example": false, "default": true }, "status": { "type": "string", "example": "active" } } }, "geolocation": { "type": "object", "properties": { "latitude": { "type": "number", "example": 51.5138332, "default": 0 }, "longitude": { "type": "number", "example": -0.1318224, "default": 0 } } }, "city": { "type": "string", "example": "New York" }, "mastercard": { "type": "object", "properties": { "estimatedActivationDate": {}, "clearingTransactionId": {}, "auth": { "type": "boolean", "example": false, "default": true }, "authTransactionId": {}, "clearing": { "type": "boolean", "example": false, "default": true }, "status": { "type": "string", "example": "active" } } }, "programId": { "type": "string", "example": "b58d8057-9159-4daf-a003-1397e28f6822" }, "amex": { "type": "object", "properties": { "estimatedActivationDate": {}, "clearingTransactionId": {}, "auth": { "type": "boolean", "example": false, "default": true }, "authTransactionId": {}, "clearing": { "type": "boolean", "example": false, "default": true }, "status": { "type": "string", "example": "active" } } }, "searchBy": { "type": "object", "properties": { "merchantIds": { "type": "object", "properties": { "mastercard": { "type": "array", "items": { "type": "string", "example": "445566" } }, "visa": { "type": "array", "items": { "type": "string", "example": "445566" } } } } } }, "id": { "type": "string", "example": "e8e44865-190b-46d0-9fcb-d23718cc6698" }, "preonboard": { "type": "boolean", "example": false, "default": true }, "postcode": { "type": "string", "example": "10036" }, "accountId": { "type": "string", "example": "3693ac7e-3e2b-432c-8c60-2b786453ca9b" }, "activeDate": { "type": "string", "example": "2020-08-19T17:21:36.327Z" }, "countryCode": { "type": "string", "example": "USA" }, "created": { "type": "string", "example": "2020-08-19T17:21:36.327Z" }, "address": { "type": "string", "example": "55 West 46th Street" }, "stateCode": { "type": "string", "example": "NY" }, "live": { "type": "boolean", "example": false, "default": true }, "updated": { "type": "string", "example": "2020-08-19T17:28:06.697Z" }, "brandId": { "type": "string", "example": "838d648e-5614-48a7-8e8b-6b3014638c66" }, "timezone": { "type": "string", "example": "America/New_York" }, "active": { "type": "boolean", "example": true, "default": true } } } }, "last": { "type": "object", "properties": { "programIdDel": { "type": "string", "example": "b58d8057-9159-4daf-a003-1397e28f68220" }, "created": { "type": "string", "example": "2020-03-14T09:19:39.431Z" }, "id": { "type": "string", "example": "cdca1e41-9577-41a8-8fa9-245592e23c68" } } }, "resource": { "type": "string", "example": "/v1/programs/b58d8057-9159-4daf-a003-1397e28f6822/locations" }, "status": { "type": "integer", "example": 200, "default": 0 }, "execution": { "type": "number", "example": 450.340728, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"resource\": \"/v1/programs/6139f5b1-ea74-44f3-b5b3s-86268dcfc4d7/locations\",\n\t\"status\": 400,\n\t\"error\": {\n\t\t\"code\": \"uuid\",\n\t\t\"date\": \"2020-08-22T09:55:29.916Z\",\n\t\t\"message\": \"Invalid uuid\"\n\t},\n\t\"execution\": 1.672985\n}" } }, "schema": { "type": "object", "properties": { "resource": { "type": "string", "example": "/v1/programs/6139f5b1-ea74-44f3-b5b3s-86268dcfc4d7/locations" }, "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "uuid" }, "date": { "type": "string", "example": "2020-08-22T09:55:29.916Z" }, "message": { "type": "string", "example": "Invalid uuid" } } }, "execution": { "type": "number", "example": 1.672985, "default": 0 } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X GET \\\n https://api.fidel.uk/v1/programs/b58d8057-9159-4daf-a003-1397e28f6822/locations \\\n -H 'content-type: application/json' \\\n -H 'fidel-key: sk_test_50ea90b6-2a3b-4a56-814d-1bc592ba4d63'" } ], "samples-languages": [ "curl" ] } } } }, "x-readme": { "headers": [ { "key": "Content-Type", "value": "application/json" } ], "explorer-enabled": false, "proxy-enabled": true }, "x-readme-fauxas": true } ```