{
    "info": {
        "_postman_id": "6682da3f-e036-c969-d9b3-4e9eb43dcb9d",
        "name": "Barazas API",
        "description": "Read-only access to your own events, programme, speakers and delegates. Authentication is HTTP Basic: the key is the username and the secret is the password, both set as collection variables. Full reference: https://barazas.com/developers",
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },
    "auth": {
        "type": "basic",
        "basic": [
            {
                "key": "username",
                "value": "{{apiKey}}",
                "type": "string"
            },
            {
                "key": "password",
                "value": "{{apiSecret}}",
                "type": "string"
            }
        ]
    },
    "variable": [
        {
            "key": "baseUrl",
            "value": "https://barazas.com/api/v1",
            "type": "string",
            "description": "The API root. Change this only if you were given a different one."
        },
        {
            "key": "apiKey",
            "value": "",
            "type": "string",
            "description": "The key from your portal, the part beginning bzk_."
        },
        {
            "key": "apiSecret",
            "value": "",
            "type": "secret",
            "description": "The secret shown once when the key was created. Keep it in an environment, not in the collection."
        },
        {
            "key": "eventSlug",
            "value": "",
            "type": "string",
            "description": "The event to ask about. Either its slug or its numeric id."
        },
        {
            "key": "attendeeId",
            "value": "",
            "type": "string",
            "description": "A delegate id, for downloading one of their uploaded answers."
        },
        {
            "key": "customFieldKey",
            "value": "",
            "type": "string",
            "description": "Which uploaded answer to download, such as an identification document or a passport photograph."
        }
    ],
    "item": [
        {
            "name": "Events",
            "request": {
                "method": "GET",
                "header": [
                    {
                        "key": "Accept",
                        "value": "application/json"
                    }
                ],
                "url": {
                    "raw": "{{baseUrl}}/client/events",
                    "host": [
                        "{{baseUrl}}"
                    ],
                    "path": [
                        "client",
                        "events"
                    ],
                    "query": []
                },
                "description": "Your events in the current active period, with counts of sessions, speakers and delegates.\n\nRequires the events:read scope."
            },
            "response": []
        },
        {
            "name": "One event",
            "request": {
                "method": "GET",
                "header": [
                    {
                        "key": "Accept",
                        "value": "application/json"
                    }
                ],
                "url": {
                    "raw": "{{baseUrl}}/client/events/{{eventSlug}}",
                    "host": [
                        "{{baseUrl}}"
                    ],
                    "path": [
                        "client",
                        "events",
                        "{{eventSlug}}"
                    ],
                    "query": []
                },
                "description": "One event. Accepts either the slug or the numeric id.\n\nRequires the events:read scope."
            },
            "response": []
        },
        {
            "name": "Programme",
            "request": {
                "method": "GET",
                "header": [
                    {
                        "key": "Accept",
                        "value": "application/json"
                    }
                ],
                "url": {
                    "raw": "{{baseUrl}}/client/events/{{eventSlug}}/programme",
                    "host": [
                        "{{baseUrl}}"
                    ],
                    "path": [
                        "client",
                        "events",
                        "{{eventSlug}}",
                        "programme"
                    ],
                    "query": []
                },
                "description": "Sessions in running order, each with its speakers, plus the list of days and the event’s timezone.\n\nRequires the programme:read scope."
            },
            "response": []
        },
        {
            "name": "Speakers",
            "request": {
                "method": "GET",
                "header": [
                    {
                        "key": "Accept",
                        "value": "application/json"
                    }
                ],
                "url": {
                    "raw": "{{baseUrl}}/client/events/{{eventSlug}}/speakers",
                    "host": [
                        "{{baseUrl}}"
                    ],
                    "path": [
                        "client",
                        "events",
                        "{{eventSlug}}",
                        "speakers"
                    ],
                    "query": []
                },
                "description": "The published line-up: name, role, organisation, country, biography and photograph.\n\nRequires the speakers:read scope."
            },
            "response": []
        },
        {
            "name": "Delegates",
            "request": {
                "method": "GET",
                "header": [
                    {
                        "key": "Accept",
                        "value": "application/json"
                    }
                ],
                "url": {
                    "raw": "{{baseUrl}}/client/events/{{eventSlug}}/attendees?status=&search=&per_page=&page=",
                    "host": [
                        "{{baseUrl}}"
                    ],
                    "path": [
                        "client",
                        "events",
                        "{{eventSlug}}",
                        "attendees"
                    ],
                    "query": [
                        {
                            "key": "status",
                            "value": "",
                            "disabled": true
                        },
                        {
                            "key": "search",
                            "value": "",
                            "disabled": true
                        },
                        {
                            "key": "per_page",
                            "value": "",
                            "disabled": true
                        },
                        {
                            "key": "page",
                            "value": "",
                            "disabled": true
                        }
                    ]
                },
                "description": "The guest list, paginated. Personal fields appear only if the key holds attendees:pii.\n\nRequires the attendees:read scope."
            },
            "response": []
        },
        {
            "name": "Download an uploaded answer",
            "request": {
                "method": "GET",
                "header": [
                    {
                        "key": "Accept",
                        "value": "application/json"
                    }
                ],
                "url": {
                    "raw": "{{baseUrl}}/client/attendees/{{attendeeId}}/files/{{customFieldKey}}",
                    "host": [
                        "{{baseUrl}}"
                    ],
                    "path": [
                        "client",
                        "attendees",
                        "{{attendeeId}}",
                        "files",
                        "{{customFieldKey}}"
                    ],
                    "query": []
                },
                "description": "One uploaded answer to an extra question, such as an identification document or a passport photograph. Needs attendees:pii.\n\nRequires the attendees:pii scope."
            },
            "response": []
        }
    ]
}