openapi: 3.0.3 info: title: Profixio description: 'API documentation for Profixio' version: 1.0.0 servers: - url: 'https://www.profixio.com/app' paths: /api/userinfo: get: summary: Permissions operationId: permissions description: 'See what permissions your api key has' parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: wsUser: applicationName: 'Odit et et modi.' contactEmail: okeefe.isidro@example.org contactName: 'Pearl Hauck Sr.' permissions: organisations: - organisationId: NFF.NO.FB viewTournament: true listTournaments: false updateAllTournaments: false updateSpecificTournament: true specificTournaments: - tournamentId: 12214 basicAccess: true extendedAccess: true properties: wsUser: type: object properties: applicationName: type: string example: 'Odit et et modi.' contactEmail: type: string example: okeefe.isidro@example.org contactName: type: string example: 'Pearl Hauck Sr.' permissions: type: object properties: organisations: type: array example: - organisationId: NFF.NO.FB viewTournament: true listTournaments: false updateAllTournaments: false updateSpecificTournament: true specificTournaments: - tournamentId: 12214 basicAccess: true extendedAccess: true items: type: object properties: organisationId: type: string example: NFF.NO.FB viewTournament: type: boolean example: true listTournaments: type: boolean example: false updateAllTournaments: type: boolean example: false updateSpecificTournament: type: boolean example: true specificTournaments: type: array example: - tournamentId: 12214 basicAccess: true extendedAccess: true items: type: object properties: tournamentId: type: integer example: 12214 basicAccess: type: boolean example: true extendedAccess: type: boolean example: true tags: - Endpoints /api/sports: get: summary: Sports operationId: sports description: "The sports registered in Profixio.\nAn organisation may have one or several associated sports." parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: BA name: bandy links: first: 'https://www.profixio.com/api/sports?page=1' last: 'https://www.profixio.com/api/sports?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/sports?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/sports' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: BA name: bandy items: type: object properties: id: type: string example: BA name: type: string example: bandy links: type: object properties: first: type: string example: 'https://www.profixio.com/api/sports?page=1' last: type: string example: 'https://www.profixio.com/api/sports?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/sports?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/sports' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Endpoints '/api/organisations/{organisation_id}/matchEventTypes': get: summary: 'Match Event Types' operationId: matchEventTypes description: "Get a list of match event types in a organisation.\n\n\nThe types are used to categorize match events.\n\nSome examples of match event types are:\n- Goal (includes number of goals)\n- Expulsion\n- Fouls\n- Start of match\n- End of match\n- Penalty competition\n\n

Period starts and stops

\nEvents that starts/stops the match or periods includes 'gamestateStartStopInfo' in the event data.\n\n

Line up

\nChanges in team lineup can be submitted in three ways (not all are supported by all organisations):\n\n- switches2Players: A single player is replaced by another player\n- isActivatingOnePlayer: A single player is marked as active\n- isTeamLineupMultiplePersons: Multiple players are replaced by multiple players. Includes \"lineUp\" in the event data." parameters: - in: query name: sport description: 'The ID of the sport.' example: HB required: false schema: type: string description: 'The ID of the sport.' example: HB - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 186 sportId: HB parentId: null name: Matchstart publicName: 'Start första halvlek' isTeamEvent: false isPersonEvent: false numberOfPersonsInEvent: null isGoalEvent: false numberOfGoals: null isTeamFoul: false isPersonFoul: false givesTimeout: false removesTimeout: false isPenaltyCompetition: false allowsComment: false penaltyDuration: minutesLimit: null minutesForPeriodsLessThanLimit: null minutesForPeriodsGreaterOrEqualToLimit: null isExpulsion: false isFullTimeExpulsion: null isYellowCard: false assignablePlayer: false assignableCoach: false assignableAssistantCoach: false benchForAttacks: null startsTimer: false stopsTimer: false allowsReport: false gamestateStartStopType: 1 gamestateStartStopInfo: startsMatch: true stopsPeriod: false startsPeriod: false stopsMatch: false startsExtraPeriod: false stopsExtraPeriod: false switches2Players: false isActivatingOnePlayer: false isTeamLineupMultiplePersons: false sign: null addsStoppageTimeForPeriod: false - id: 187 sportId: HB parentId: null name: 'Halvlek slut' publicName: '%%omgang%%:a halvlek är slut' isTeamEvent: false isPersonEvent: false numberOfPersonsInEvent: null isGoalEvent: false numberOfGoals: null isTeamFoul: false isPersonFoul: false givesTimeout: false removesTimeout: false isPenaltyCompetition: false allowsComment: false penaltyDuration: minutesLimit: null minutesForPeriodsLessThanLimit: null minutesForPeriodsGreaterOrEqualToLimit: null isExpulsion: false isFullTimeExpulsion: null isYellowCard: false assignablePlayer: false assignableCoach: false assignableAssistantCoach: false benchForAttacks: null startsTimer: false stopsTimer: false allowsReport: false gamestateStartStopType: 2 gamestateStartStopInfo: startsMatch: false stopsPeriod: true startsPeriod: false stopsMatch: false startsExtraPeriod: false stopsExtraPeriod: false switches2Players: false isActivatingOnePlayer: false isTeamLineupMultiplePersons: false sign: null addsStoppageTimeForPeriod: false properties: data: type: array example: - id: 186 sportId: HB parentId: null name: Matchstart publicName: 'Start första halvlek' isTeamEvent: false isPersonEvent: false numberOfPersonsInEvent: null isGoalEvent: false numberOfGoals: null isTeamFoul: false isPersonFoul: false givesTimeout: false removesTimeout: false isPenaltyCompetition: false allowsComment: false penaltyDuration: minutesLimit: null minutesForPeriodsLessThanLimit: null minutesForPeriodsGreaterOrEqualToLimit: null isExpulsion: false isFullTimeExpulsion: null isYellowCard: false assignablePlayer: false assignableCoach: false assignableAssistantCoach: false benchForAttacks: null startsTimer: false stopsTimer: false allowsReport: false gamestateStartStopType: 1 gamestateStartStopInfo: startsMatch: true stopsPeriod: false startsPeriod: false stopsMatch: false startsExtraPeriod: false stopsExtraPeriod: false switches2Players: false isActivatingOnePlayer: false isTeamLineupMultiplePersons: false sign: null addsStoppageTimeForPeriod: false - id: 187 sportId: HB parentId: null name: 'Halvlek slut' publicName: '%%omgang%%:a halvlek är slut' isTeamEvent: false isPersonEvent: false numberOfPersonsInEvent: null isGoalEvent: false numberOfGoals: null isTeamFoul: false isPersonFoul: false givesTimeout: false removesTimeout: false isPenaltyCompetition: false allowsComment: false penaltyDuration: minutesLimit: null minutesForPeriodsLessThanLimit: null minutesForPeriodsGreaterOrEqualToLimit: null isExpulsion: false isFullTimeExpulsion: null isYellowCard: false assignablePlayer: false assignableCoach: false assignableAssistantCoach: false benchForAttacks: null startsTimer: false stopsTimer: false allowsReport: false gamestateStartStopType: 2 gamestateStartStopInfo: startsMatch: false stopsPeriod: true startsPeriod: false stopsMatch: false startsExtraPeriod: false stopsExtraPeriod: false switches2Players: false isActivatingOnePlayer: false isTeamLineupMultiplePersons: false sign: null addsStoppageTimeForPeriod: false items: type: object properties: id: type: integer example: 186 sportId: type: string example: HB parentId: type: string example: null name: type: string example: Matchstart publicName: type: string example: 'Start första halvlek' isTeamEvent: type: boolean example: false isPersonEvent: type: boolean example: false numberOfPersonsInEvent: type: string example: null isGoalEvent: type: boolean example: false numberOfGoals: type: string example: null isTeamFoul: type: boolean example: false isPersonFoul: type: boolean example: false givesTimeout: type: boolean example: false removesTimeout: type: boolean example: false isPenaltyCompetition: type: boolean example: false allowsComment: type: boolean example: false penaltyDuration: type: object properties: minutesLimit: type: string example: null minutesForPeriodsLessThanLimit: type: string example: null minutesForPeriodsGreaterOrEqualToLimit: type: string example: null isExpulsion: type: boolean example: false isFullTimeExpulsion: type: string example: null isYellowCard: type: boolean example: false assignablePlayer: type: boolean example: false assignableCoach: type: boolean example: false assignableAssistantCoach: type: boolean example: false benchForAttacks: type: string example: null startsTimer: type: boolean example: false stopsTimer: type: boolean example: false allowsReport: type: boolean example: false gamestateStartStopType: type: integer example: 1 gamestateStartStopInfo: type: object properties: startsMatch: type: boolean example: true stopsPeriod: type: boolean example: false startsPeriod: type: boolean example: false stopsMatch: type: boolean example: false startsExtraPeriod: type: boolean example: false stopsExtraPeriod: type: boolean example: false switches2Players: type: boolean example: false isActivatingOnePlayer: type: boolean example: false isTeamLineupMultiplePersons: type: boolean example: false sign: type: string example: null addsStoppageTimeForPeriod: type: boolean example: false tags: - Matches parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SHF.SE.HB required: true schema: type: string '/api/seasons/{season_id}/matches': get: summary: 'Matches in a season' operationId: matchesInASeason description: "Get a list of matches in a season\n\n\n\nSee Tournament -> Matches for matches for a specific tournament." parameters: - in: query name: updated description: 'Display where the record was updated after
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-24 08:00:00' required: false schema: type: string description: 'Display where the record was updated after
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-24 08:00:00' - in: query name: fromDate description: 'Display where date is >= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-01' required: false schema: type: string description: 'Display where date is >= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-01' - in: query name: toDate description: 'Display where date is <= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-05 14:40:00' required: false schema: type: string description: 'Display where date is <= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-05 14:40:00' - in: query name: include_referee_ids description: 'Include list of referee ids in the response (for leagues).' example: true required: false schema: type: boolean description: 'Include list of referee ids in the response (for leagues).' example: true - in: query name: matchCategory description: 'Display where match category is equal to this value.' example: 3247289 required: false schema: type: integer description: 'Display where match category is equal to this value.' example: 3247289 - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: [] links: first: 'https://www.profixio.com/api/seasons/711/matches?page=1' last: 'https://www.profixio.com/api/seasons/711/matches?page=1' prev: null next: null meta: current_page: 1 from: null last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/seasons/711/matches?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/seasons/711/matches' per_page: 15 to: null total: 0 properties: data: type: array example: [] links: type: object properties: first: type: string example: 'https://www.profixio.com/api/seasons/711/matches?page=1' last: type: string example: 'https://www.profixio.com/api/seasons/711/matches?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: string example: null last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/seasons/711/matches?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/seasons/711/matches' per_page: type: integer example: 15 to: type: string example: null total: type: integer example: 0 tags: - Matches parameters: - in: path name: season_id description: 'The ID of the season.' example: 711 required: true schema: type: integer '/api/seasons/{season_id}/deletedMatches': get: summary: 'Deleted matches in a season' operationId: deletedMatchesInASeason description: "Get a list of matches in a season that has been deleted\n\n" parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: query name: since description: "Display where the record was deleted after.\nFormat is: YYYY-MM-DD HH:MM:SS" example: '2022-10-24 08:00:00' required: false schema: type: string description: "Display where the record was deleted after.\nFormat is: YYYY-MM-DD HH:MM:SS" example: '2022-10-24 08:00:00' - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: [] links: first: 'https://www.profixio.com/api/seasons/711/deletedMatches?page=1' last: 'https://www.profixio.com/api/seasons/711/deletedMatches?page=1' prev: null next: null meta: current_page: 1 from: null last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/seasons/711/deletedMatches?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/seasons/711/deletedMatches' per_page: 15 to: null total: 0 properties: data: type: array example: [] links: type: object properties: first: type: string example: 'https://www.profixio.com/api/seasons/711/deletedMatches?page=1' last: type: string example: 'https://www.profixio.com/api/seasons/711/deletedMatches?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: string example: null last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/seasons/711/deletedMatches?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/seasons/711/deletedMatches' per_page: type: integer example: 15 to: type: string example: null total: type: integer example: 0 tags: - Matches parameters: - in: path name: season_id description: 'The ID of the season.' example: 711 required: true schema: type: integer '/api/tournaments/{tournament_id}/tables': get: summary: 'Match tables for a tournament' operationId: matchTablesForATournament description: "Get the match tables for a tournament. The tables are grouped by match category,\nand by match groups." parameters: - in: query name: matchCategory description: 'Display where match category is equal to this value.' example: 3247289 required: false schema: type: integer description: 'Display where match category is equal to this value.' example: 3247289 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: type: object example: [] tags: - Matches parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 6 required: true schema: type: integer '/api/tournaments/{tournament_id}/matches': get: summary: 'Matches in a tournament' operationId: matchesInATournament description: "Get the matches for a tournament/league.\nThe matches are grouped by match category, and by match groups.\n\nIncludes the matchgroups and matchcategories.\n\n" parameters: - in: query name: updated description: 'Display where the record was updated after
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-24 08:00:00' required: false schema: type: string description: 'Display where the record was updated after
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-24 08:00:00' - in: query name: fromDate description: 'Display where date is >= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-01' required: false schema: type: string description: 'Display where date is >= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-01' - in: query name: toDate description: 'Display where date is <= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-05 14:40:00' required: false schema: type: string description: 'Display where date is <= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-05 14:40:00' - in: query name: include_referee_ids description: 'Include list of referee ids in the response (for leagues).' example: true required: false schema: type: boolean description: 'Include list of referee ids in the response (for leagues).' example: true - in: query name: matchCategory description: 'Display where match category is equal to this value.' example: 3247289 required: false schema: type: integer description: 'Display where match category is equal to this value.' example: 3247289 - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: [] links: first: 'https://www.profixio.com/api/tournaments/10/matches?page=1' last: 'https://www.profixio.com/api/tournaments/10/matches?page=1' prev: null next: null meta: current_page: 1 from: null last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/matches?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/tournaments/10/matches' per_page: 15 to: null total: 0 properties: data: type: array example: [] links: type: object properties: first: type: string example: 'https://www.profixio.com/api/tournaments/10/matches?page=1' last: type: string example: 'https://www.profixio.com/api/tournaments/10/matches?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: string example: null last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/matches?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/tournaments/10/matches' per_page: type: integer example: 15 to: type: string example: null total: type: integer example: 0 tags: - Matches parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/tournaments/{tournament_id}/matches/{match_id}': get: summary: 'Match by id' operationId: matchById description: "Get a specific match for a tournament/league.\n\nIncludes the matchgroups and matchcategories." parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 30843160 txid: 44 number: '44' tournamentId: 10 name: '' gameRound: 1 date: '2019-11-25' time: '09:30:00' homeTeam: teamRegistrationId: 721490 globalTeamId: null name: Croatia goals: null isWinner: false seeding: null awayTeam: teamRegistrationId: 721480 globalTeamId: null name: 'Czech Republic' goals: null isWinner: false seeding: null hasWinner: false winnerTeam: null field: id: 1227139 name: Bane1 arena: id: 205514 arenaName: Standard isHidden: false periodInfo: periodLength: 1 slotLength: 15 numberOfPeriods: 1 pauseLength: 0 extraPeriodLength: null isGroupPlay: true isLeaguePlay: false isPlayoff: false playoffLevel: null includedInTableCalculation: true matchCategory: id: 1102493 name: Men categoryCode: M matchGroup: id: 3247289 displayName: B name: '2' matchLeague: null settResultsFormatted: null sets: [] matchUrl: 'http://www.profixio.com/app/uefaeurosintef/match/30843160' matchDataUpdated: '2024-09-01T15:40:30.605067Z' resultsUpdated: null fieldUpdated: null teamsUpdated: null lineupAvailableFrom: '2019-11-25T08:25:00Z' datetimeStart: '2019-11-25T08:30:00Z' spectators: null organizerGlobalClubId: null properties: data: type: object properties: id: type: integer example: 30843160 txid: type: integer example: 44 number: type: string example: '44' tournamentId: type: integer example: 10 name: type: string example: '' gameRound: type: integer example: 1 date: type: string example: '2019-11-25' time: type: string example: '09:30:00' homeTeam: type: object properties: teamRegistrationId: type: integer example: 721490 globalTeamId: type: string example: null name: type: string example: Croatia goals: type: string example: null isWinner: type: boolean example: false seeding: type: string example: null awayTeam: type: object properties: teamRegistrationId: type: integer example: 721480 globalTeamId: type: string example: null name: type: string example: 'Czech Republic' goals: type: string example: null isWinner: type: boolean example: false seeding: type: string example: null hasWinner: type: boolean example: false winnerTeam: type: string example: null field: type: object properties: id: type: integer example: 1227139 name: type: string example: Bane1 arena: type: object properties: id: type: integer example: 205514 arenaName: type: string example: Standard isHidden: type: boolean example: false periodInfo: type: object properties: periodLength: type: integer example: 1 slotLength: type: integer example: 15 numberOfPeriods: type: integer example: 1 pauseLength: type: integer example: 0 extraPeriodLength: type: string example: null isGroupPlay: type: boolean example: true isLeaguePlay: type: boolean example: false isPlayoff: type: boolean example: false playoffLevel: type: string example: null includedInTableCalculation: type: boolean example: true matchCategory: type: object properties: id: type: integer example: 1102493 name: type: string example: Men categoryCode: type: string example: M matchGroup: type: object properties: id: type: integer example: 3247289 displayName: type: string example: B name: type: string example: '2' matchLeague: type: string example: null settResultsFormatted: type: string example: null sets: type: array example: [] matchUrl: type: string example: 'http://www.profixio.com/app/uefaeurosintef/match/30843160' matchDataUpdated: type: string example: '2024-09-01T15:40:30.605067Z' resultsUpdated: type: string example: null fieldUpdated: type: string example: null teamsUpdated: type: string example: null lineupAvailableFrom: type: string example: '2019-11-25T08:25:00Z' datetimeStart: type: string example: '2019-11-25T08:30:00Z' spectators: type: string example: null organizerGlobalClubId: type: string example: null tags: - Matches put: summary: 'Update match' operationId: updateMatch description: 'Update the score for a match.' parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 204: description: '' tags: - Matches requestBody: required: false content: application/json: schema: type: object properties: result: type: object description: 'The result of the match. The result is required if using sets.' example: [] properties: home: type: integer description: 'The home team score.' example: 2 away: type: integer description: 'The away team score.' example: 1 sets: type: array description: 'The sets of the match. Only for volleyball etc.' example: - [] items: type: object properties: home: type: integer description: 'The home team score in the set.' example: 21 away: type: integer description: 'The away team score in the set.' example: 19 parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer - in: path name: match_id description: 'The ID of the match.' example: 30843160 required: true schema: type: integer '/api/tournaments/{tournament_id}/matches/{match_id}/lineup': get: summary: 'Match lineup / staff and players' operationId: matchLineupStaffAndPlayers description: "Get the lineup for a match.\nAvailable some minutes before match start. Varies from tournament to tournament.\n\nSee the match->lineupAvailableFrom field.\n\nIf called before x minutes, the server responds with a 403 Forbidden." parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"data\": {\n \"home\": {\n \"staff\": [\n {\n \"id\": 655735,\n \"addedManually\": false,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"personId\": 48668812,\n \"birthDate\": '1980-01-02',\n \"role\": {\n \"id\": 2,\n \"name\": \"Coach\"\n }\n }\n ],\n \"players\": [\n {\n \"id\": 864135,\n \"number\": \"1\",\n \"addedManually\": false,\n \"firstName\": \"Kenny\",\n \"lastName\": \"Maduro\",\n \"position\": null,\n \"personId\": 332342,\n \"birthDate\": \"2002-05-11\",\n \"isCaptain\": false\n },\n {\n \"id\": 8642232,\n \"number\": \"2\",\n \"addedManually\": true,\n \"firstName\": \"Cristiano\",\n \"lastName\": \"Ronaldo\",\n \"position\":\n {\n \"id\": 4,\n \"name\": \"MV\",\n \"goalkeeper\": true\n }\n \"personId\": null,\n \"birthDate\": null,\n \"isCaptain\": false\n }\n ]\n },\n \"away\": {\n \"staff\": [],\n \"players\": []\n }\n }\n}" 403: description: 'Lineup not available yet' content: application/json: schema: type: object example: message: 'Lineup not available yet' properties: message: type: string example: 'Lineup not available yet' tags: - Matches parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer - in: path name: match_id description: 'The ID of the match.' example: 30843160 required: true schema: type: integer '/api/tournaments/{tournament_id}/matches/{match_id}/events': get: summary: 'Match Protocol Events' operationId: matchProtocolEvents description: "List of match events.\nMost recent events first.\n\nThe event types vary from sport to sport.\n\nEvents of type \"gamestateStartStopType\" are used to indicate the start and end of a game or period.\n\nSome events are team specific, and some are player/staff specific. The teamId field indicates which team the event belongs to.\nThe \"person\" field is only set for player/staff specific events.\n\nSome events also have a second person, for example a player who is substituted, or a goal with an assist.\nThe \"person2\" field is only set for events with a second person.\n\nIn some cases, goals does not have a person field. This means that the secretary has not yet entered the player who scored the goal.\n\nAll events include the current score.\n\nGame time:\nSome matches have a match clock, some may not. The \"totalGameTime\", \"timeInPeriod\" and \"overtimeInperiod\" fields are only set for matches with a match clock." parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 1108827 eventTypeId: 189 description: 'Matchen är slut' isTeamEvent: false teamId: null teamName: null currentScore: home: 13 away: 44 isShootoutRound: false shootoutScore: null totalGameTime: '60:00' displayGameTime: '60:00' period: 2 timeInPeriod: '30.00' overtimeInperiod: '0.00' comment: null goals: null symbol: '' timeout: false startsPenaltyCompetition: false isExpulsion: false penalty: null switches2Players: false isTeamLineupMultiplePersons: false isActivatingOnePlayer: false gamestateStartStopType: 4 isTeamFoul: false isPersonFoul: false hasReport: false created_at: '2023-08-19T14:28:20.000000Z' sortOrder: 2300000 startedAt: '2023-08-19T14:28:20.000000Z' pausedAt: null addSeconds: null startsMatch: false stopsPeriod: false startsPeriod: false stopsMatch: true startsExtraPeriod: false stopsExtraPeriod: false properties: data: type: array example: - id: 1108827 eventTypeId: 189 description: 'Matchen är slut' isTeamEvent: false teamId: null teamName: null currentScore: home: 13 away: 44 isShootoutRound: false shootoutScore: null totalGameTime: '60:00' displayGameTime: '60:00' period: 2 timeInPeriod: '30.00' overtimeInperiod: '0.00' comment: null goals: null symbol: '' timeout: false startsPenaltyCompetition: false isExpulsion: false penalty: null switches2Players: false isTeamLineupMultiplePersons: false isActivatingOnePlayer: false gamestateStartStopType: 4 isTeamFoul: false isPersonFoul: false hasReport: false created_at: '2023-08-19T14:28:20.000000Z' sortOrder: 2300000 startedAt: '2023-08-19T14:28:20.000000Z' pausedAt: null addSeconds: null startsMatch: false stopsPeriod: false startsPeriod: false stopsMatch: true startsExtraPeriod: false stopsExtraPeriod: false items: type: object properties: id: type: integer example: 1108827 eventTypeId: type: integer example: 189 description: type: string example: 'Matchen är slut' isTeamEvent: type: boolean example: false teamId: type: string example: null teamName: type: string example: null currentScore: type: object properties: home: type: integer example: 13 away: type: integer example: 44 isShootoutRound: type: boolean example: false shootoutScore: type: string example: null totalGameTime: type: string example: '60:00' displayGameTime: type: string example: '60:00' period: type: integer example: 2 timeInPeriod: type: string example: '30.00' overtimeInperiod: type: string example: '0.00' comment: type: string example: null goals: type: string example: null symbol: type: string example: '' timeout: type: boolean example: false startsPenaltyCompetition: type: boolean example: false isExpulsion: type: boolean example: false penalty: type: string example: null switches2Players: type: boolean example: false isTeamLineupMultiplePersons: type: boolean example: false isActivatingOnePlayer: type: boolean example: false gamestateStartStopType: type: integer example: 4 isTeamFoul: type: boolean example: false isPersonFoul: type: boolean example: false hasReport: type: boolean example: false created_at: type: string example: '2023-08-19T14:28:20.000000Z' sortOrder: type: integer example: 2300000 startedAt: type: string example: '2023-08-19T14:28:20.000000Z' pausedAt: type: string example: null addSeconds: type: string example: null startsMatch: type: boolean example: false stopsPeriod: type: boolean example: false startsPeriod: type: boolean example: false stopsMatch: type: boolean example: true startsExtraPeriod: type: boolean example: false stopsExtraPeriod: type: boolean example: false tags: - Matches parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 34301 required: true schema: type: integer - in: path name: match_id description: 'The ID of the match.' example: 31553763 required: true schema: type: integer '/api/organisations/{id}': get: summary: 'Organisation by id' operationId: organisationById description: 'Basic information about the current organisation.' parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: ALIQUAM.QUI.GL name: voluptatem email: lawrence.stracke@hotmail.com country: SR sports: [] properties: data: type: object properties: id: type: string example: ALIQUAM.QUI.GL name: type: string example: voluptatem email: type: string example: lawrence.stracke@hotmail.com country: type: string example: SR sports: type: array example: [] tags: - Organisation parameters: - in: path name: id description: 'The ID of the organisation.' example: ALIQUAM.QUI.GL required: true schema: type: integer - in: path name: organisation_id description: 'The ID of the organisation.' example: SVBF.SE.SVB required: true schema: type: string '/api/organisations/{organisation_id}/categories': get: summary: 'Categories in a organisation' operationId: categoriesInAOrganisation description: "List of categories for an organisation.\n\nThe categories are kept between seasons.\n\nEach league tournament must belong to a Category." parameters: - in: query name: sportId description: 'Filter the result for a specific sport. BB, VB, FB etc. Must be at least 2 characters.' example: VB required: false schema: type: string description: 'Filter the result for a specific sport. BB, VB, FB etc. Must be at least 2 characters.' example: VB - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 13 description: Elitserien level: 2 sport: VB belongsToDistrict: false adminDistrictId: null links: first: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/categories?page=1' last: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/categories?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/categories?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/categories' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 13 description: Elitserien level: 2 sport: VB belongsToDistrict: false adminDistrictId: null items: type: object properties: id: type: integer example: 13 description: type: string example: Elitserien level: type: integer example: 2 sport: type: string example: VB belongsToDistrict: type: boolean example: false adminDistrictId: type: string example: null links: type: object properties: first: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/categories?page=1' last: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/categories?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/categories?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/categories' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Organisation parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SVBF.SE.SVB required: true schema: type: string '/api/organisations/{organisation_id}/clubs': get: summary: 'GlobalClubs in a organisation' operationId: globalClubsInAOrganisation description: "A GlobalClub may participate in many tournaments.\n\nSee the globalClubId field on TeamRegistrations and Clubs in a tournament.\n\nFor swedish organisations, the legacyId maps to the club id in IdrottOnline" parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 2415 name: 'Alingsås Volleybollklubb' shortName: 'Alingsås VK' districtId: 55 legacyiD: '10461' updatedAt: '2024-06-28 13:41:22' links: first: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/clubs?page=1' last: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/clubs?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/clubs?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/clubs' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 2415 name: 'Alingsås Volleybollklubb' shortName: 'Alingsås VK' districtId: 55 legacyiD: '10461' updatedAt: '2024-06-28 13:41:22' items: type: object properties: id: type: integer example: 2415 name: type: string example: 'Alingsås Volleybollklubb' shortName: type: string example: 'Alingsås VK' districtId: type: integer example: 55 legacyiD: type: string example: '10461' updatedAt: type: string example: '2024-06-28 13:41:22' links: type: object properties: first: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/clubs?page=1' last: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/clubs?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/clubs?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/clubs' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Organisation parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SVBF.SE.SVB required: true schema: type: string '/api/organisations/{organisation_id}/districts': get: summary: 'Get all districts for an organisation' operationId: getAllDistrictsForAnOrganisation description: '' parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 802 name: 'Handbollförbundet Öst' shortname: 'HF Öst' external_id: 268 postal_code: '11860' place: STOCKHOLM adress: 'Skansbrogatan 7, Idrottens Hus' adress2: '' organisationnumber: 802001-3499 links: first: 'https://www.profixio.com/api/organisations/SHF.SE.HB/districts?page=1' last: 'https://www.profixio.com/api/organisations/SHF.SE.HB/districts?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SHF.SE.HB/districts?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/organisations/SHF.SE.HB/districts' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 802 name: 'Handbollförbundet Öst' shortname: 'HF Öst' external_id: 268 postal_code: '11860' place: STOCKHOLM adress: 'Skansbrogatan 7, Idrottens Hus' adress2: '' organisationnumber: 802001-3499 items: type: object properties: id: type: integer example: 802 name: type: string example: 'Handbollförbundet Öst' shortname: type: string example: 'HF Öst' external_id: type: integer example: 268 postal_code: type: string example: '11860' place: type: string example: STOCKHOLM adress: type: string example: 'Skansbrogatan 7, Idrottens Hus' adress2: type: string example: '' organisationnumber: type: string example: 802001-3499 links: type: object properties: first: type: string example: 'https://www.profixio.com/api/organisations/SHF.SE.HB/districts?page=1' last: type: string example: 'https://www.profixio.com/api/organisations/SHF.SE.HB/districts?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SHF.SE.HB/districts?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/organisations/SHF.SE.HB/districts' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Organisation parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SHF.SE.HB required: true schema: type: string '/api/organisations/{organisation_id}/districts/{id}': get: summary: 'Get a district' operationId: getADistrict description: '' parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 802 name: 'Handbollförbundet Öst' shortname: 'HF Öst' external_id: 268 postal_code: '11860' place: STOCKHOLM adress: 'Skansbrogatan 7, Idrottens Hus' adress2: '' organisationnumber: 802001-3499 properties: data: type: object properties: id: type: integer example: 802 name: type: string example: 'Handbollförbundet Öst' shortname: type: string example: 'HF Öst' external_id: type: integer example: 268 postal_code: type: string example: '11860' place: type: string example: STOCKHOLM adress: type: string example: 'Skansbrogatan 7, Idrottens Hus' adress2: type: string example: '' organisationnumber: type: string example: 802001-3499 tags: - Organisation parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SHF.SE.HB required: true schema: type: string - in: path name: id description: 'The ID of the district.' example: 802 required: true schema: type: integer '/api/organisations/{organisation_id}/allPlayers': get: summary: 'All players in a organisation' operationId: allPlayersInAOrganisation description: "If you want to filter by club, you can use the club_id parameter. For large organisations, this can be useful to reduce the number of players returned.\n\nAlso shows current ranking points for Swedish Bordtennis\n\nThis endpoint is not paginated.\n\nRequired scope: read_all_players_in_organisation" parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 76197 firstName: Libby lastName: Bradtke birthYear: '1976' birthDate: '1976-06-15' playerClubIdsLicensed: '2919' playerClubId: 2919 gender: M rankingPoints: 1555 rankingPlacement: 1142 contractClubIds: null - id: 78637 firstName: Elton lastName: Conroy birthYear: '1976' birthDate: '1976-06-12' playerClubIdsLicensed: '2919' playerClubId: 2919 gender: M rankingPoints: 1606 rankingPlacement: 1023 contractClubIds: null properties: data: type: array example: - id: 76197 firstName: Libby lastName: Bradtke birthYear: '1976' birthDate: '1976-06-15' playerClubIdsLicensed: '2919' playerClubId: 2919 gender: M rankingPoints: 1555 rankingPlacement: 1142 contractClubIds: null - id: 78637 firstName: Elton lastName: Conroy birthYear: '1976' birthDate: '1976-06-12' playerClubIdsLicensed: '2919' playerClubId: 2919 gender: M rankingPoints: 1606 rankingPlacement: 1023 contractClubIds: null items: type: object properties: id: type: integer example: 76197 firstName: type: string example: Libby lastName: type: string example: Bradtke birthYear: type: string example: '1976' birthDate: type: string example: '1976-06-15' playerClubIdsLicensed: type: string example: '2919' playerClubId: type: integer example: 2919 gender: type: string example: M rankingPoints: type: integer example: 1555 rankingPlacement: type: integer example: 1142 contractClubIds: type: string example: null tags: - Organisation requestBody: required: false content: application/json: schema: type: object properties: club_id: type: number description: 'Optional filter for the club ID.' example: 2919.0 parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SBTF.SE.BT required: true schema: type: string '/api/organisations/{organisation_id}/invoices': get: summary: 'Lists club invoices for an organisation' operationId: listsClubInvoicesForAnOrganisation description: 'requires scope: update_invoices_fx_organisation' parameters: - in: query name: createdFromDate description: 'Display where date is >= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-01' required: false schema: type: string description: 'Display where date is >= to this value
Format: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD . Must be a valid date.' example: '2022-10-01' - in: query name: isExported description: 'Display where the record is exported.' example: true required: false schema: type: boolean description: 'Display where the record is exported.' example: true - in: query name: fromNumber description: 'Display where number is >= to this value.' example: 1 required: false schema: type: integer description: 'Display where number is >= to this value.' example: 1 - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - invoice: number: 0 date: '2009-12-14' due_date: '2009-12-19' paid_date: null sent_at: null paid_amount: 0 exported: false sum: 0 credited_amount: 0 remaining_amount: 0 is_paid: true eksport_status_code: null export_status_message: null head: topptekst: null forbund_adresse: null forbund_postnr: null forbund_poststed: null forbund_telefon: null forbund_telefaks: null forbund_epost: null forbund_hjemmeside: null forbund_iban: null forbund_swift: null forbund_organisasjonsnummer: null forbund_konto: null id: null klubbid: null fakturanr: null eksternid: null navn: null kontaktnavn: null adresse: null postnr: null poststed: null opprettetdato: null forfalldato: null lines: [] - invoice: number: 0 date: '2009-12-14' due_date: '2009-12-19' paid_date: null sent_at: null paid_amount: 0 exported: false sum: 0 credited_amount: 0 remaining_amount: 0 is_paid: true eksport_status_code: null export_status_message: null head: topptekst: null forbund_adresse: null forbund_postnr: null forbund_poststed: null forbund_telefon: null forbund_telefaks: null forbund_epost: null forbund_hjemmeside: null forbund_iban: null forbund_swift: null forbund_organisasjonsnummer: null forbund_konto: null id: null klubbid: null fakturanr: null eksternid: null navn: null kontaktnavn: null adresse: null postnr: null poststed: null opprettetdato: null forfalldato: null lines: [] properties: data: type: array example: - invoice: number: 0 date: '2009-12-14' due_date: '2009-12-19' paid_date: null sent_at: null paid_amount: 0 exported: false sum: 0 credited_amount: 0 remaining_amount: 0 is_paid: true eksport_status_code: null export_status_message: null head: topptekst: null forbund_adresse: null forbund_postnr: null forbund_poststed: null forbund_telefon: null forbund_telefaks: null forbund_epost: null forbund_hjemmeside: null forbund_iban: null forbund_swift: null forbund_organisasjonsnummer: null forbund_konto: null id: null klubbid: null fakturanr: null eksternid: null navn: null kontaktnavn: null adresse: null postnr: null poststed: null opprettetdato: null forfalldato: null lines: [] - invoice: number: 0 date: '2009-12-14' due_date: '2009-12-19' paid_date: null sent_at: null paid_amount: 0 exported: false sum: 0 credited_amount: 0 remaining_amount: 0 is_paid: true eksport_status_code: null export_status_message: null head: topptekst: null forbund_adresse: null forbund_postnr: null forbund_poststed: null forbund_telefon: null forbund_telefaks: null forbund_epost: null forbund_hjemmeside: null forbund_iban: null forbund_swift: null forbund_organisasjonsnummer: null forbund_konto: null id: null klubbid: null fakturanr: null eksternid: null navn: null kontaktnavn: null adresse: null postnr: null poststed: null opprettetdato: null forfalldato: null lines: [] items: type: object properties: invoice: type: object properties: number: type: integer example: 0 date: type: string example: '2009-12-14' due_date: type: string example: '2009-12-19' paid_date: type: string example: null sent_at: type: string example: null paid_amount: type: integer example: 0 exported: type: boolean example: false sum: type: integer example: 0 credited_amount: type: integer example: 0 remaining_amount: type: integer example: 0 is_paid: type: boolean example: true eksport_status_code: type: string example: null export_status_message: type: string example: null head: type: object properties: topptekst: type: string example: null forbund_adresse: type: string example: null forbund_postnr: type: string example: null forbund_poststed: type: string example: null forbund_telefon: type: string example: null forbund_telefaks: type: string example: null forbund_epost: type: string example: null forbund_hjemmeside: type: string example: null forbund_iban: type: string example: null forbund_swift: type: string example: null forbund_organisasjonsnummer: type: string example: null forbund_konto: type: string example: null id: type: string example: null klubbid: type: string example: null fakturanr: type: string example: null eksternid: type: string example: null navn: type: string example: null kontaktnavn: type: string example: null adresse: type: string example: null postnr: type: string example: null poststed: type: string example: null opprettetdato: type: string example: null forfalldato: type: string example: null lines: type: array example: [] tags: - Organisation parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SBF.SE.BR required: true schema: type: string '/api/organisations/{organisation_id}/invoices/{number}': get: summary: 'Show a specific invoice' operationId: showASpecificInvoice description: 'requires scope: update_invoices_fx_organisation' parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: invoice: number: 0 date: '2009-12-14' due_date: '2009-12-19' paid_date: null sent_at: null paid_amount: 0 exported: false sum: 0 credited_amount: 0 remaining_amount: 0 is_paid: true eksport_status_code: null export_status_message: null head: topptekst: null forbund_adresse: null forbund_postnr: null forbund_poststed: null forbund_telefon: null forbund_telefaks: null forbund_epost: null forbund_hjemmeside: null forbund_iban: null forbund_swift: null forbund_organisasjonsnummer: null forbund_konto: null id: null klubbid: null fakturanr: null eksternid: null navn: null kontaktnavn: null adresse: null postnr: null poststed: null opprettetdato: null forfalldato: null lines: [] properties: data: type: object properties: invoice: type: object properties: number: type: integer example: 0 date: type: string example: '2009-12-14' due_date: type: string example: '2009-12-19' paid_date: type: string example: null sent_at: type: string example: null paid_amount: type: integer example: 0 exported: type: boolean example: false sum: type: integer example: 0 credited_amount: type: integer example: 0 remaining_amount: type: integer example: 0 is_paid: type: boolean example: true eksport_status_code: type: string example: null export_status_message: type: string example: null head: type: object properties: topptekst: type: string example: null forbund_adresse: type: string example: null forbund_postnr: type: string example: null forbund_poststed: type: string example: null forbund_telefon: type: string example: null forbund_telefaks: type: string example: null forbund_epost: type: string example: null forbund_hjemmeside: type: string example: null forbund_iban: type: string example: null forbund_swift: type: string example: null forbund_organisasjonsnummer: type: string example: null forbund_konto: type: string example: null id: type: string example: null klubbid: type: string example: null fakturanr: type: string example: null eksternid: type: string example: null navn: type: string example: null kontaktnavn: type: string example: null adresse: type: string example: null postnr: type: string example: null poststed: type: string example: null opprettetdato: type: string example: null forfalldato: type: string example: null lines: type: array example: [] tags: - Organisation parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SBF.SE.BR required: true schema: type: string - in: path name: number description: 'The invoice number.' example: 123456 required: true schema: type: integer '/api/organisations/{organisation_id}/invoices/bulkUpdate': post: summary: 'Bulk update' operationId: bulkUpdate description: "Update the exported status, and paid status of invoices\n\n1. After importing invoices, set export status to 200 if successful, 400 if failed.\n2. After receiving payment, set paid date and amount.\n\nrequires scope: update_invoices_fx_organisation" parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: { } tags: - Organisation requestBody: required: true content: application/json: schema: type: object properties: invoices: type: array description: '' example: - [] items: type: object properties: number: type: integer description: 'The invoice number.' example: 107 export_status_code: type: integer description: 'The status code of the update. 200 for when your system could recreate the invoice, 400 for failure.' example: 200 enum: - '200' - '400' export_status_message: type: string description: 'The status message of the export process.' example: 'Invoice 107 created in TotalInvoice' paid_date: type: string description: 'The date the invoice was paid. Must be a valid date.' example: '2021-01-01' paid_amount: type: number description: 'The amount paid.' example: 100.0 credited_amount: type: number description: 'The amount credited.' example: 100.0 required: - number required: - invoices parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: ALIQUAM.QUI.GL required: true schema: type: integer '/api/tournaments/{tournament_id}/rankingpoints': get: summary: 'RankingPoints for a tournament' operationId: rankingPointsForATournament description: "" parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: type: object example: - lag_id: 1080287 fk_klasse: 159911 lag_klasse: D entrypoeng: 333 entrypoeng_sort: 333.00000245 playerpoints: '89861': 88 '43821': 245 tags: - Ranking parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/tournaments/{tournament_id}/rankingpoints/{lag_lag_id}': get: summary: 'RankingPoints for a team' operationId: rankingPointsForATeam description: "Only returns data if the tournament uses ranking.\nMostly used for volleyball (NVBF / SVBF)" parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: lag_id: 1080287 fk_klasse: 159911 lag_klasse: D entrypoeng: 333 entrypoeng_sort: 333.00000245 playerpoints: '89861': 88 '43821': 245 properties: lag_id: type: integer example: 1080287 fk_klasse: type: integer example: 159911 lag_klasse: type: string example: D entrypoeng: type: integer example: 333 entrypoeng_sort: type: number example: 333.00000245 playerpoints: type: object properties: 89861: type: integer example: 88 43821: type: integer example: 245 tags: - Ranking parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer - in: path name: lag_lag_id description: 'The ID of the team.' example: 721480 required: true schema: type: integer '/api/organisations/{organisation_id}/seasons': get: summary: 'Seasons in a organisation' operationId: seasonsInAOrganisation description: "List of seasons for an organisation\n\nSorting: Newest seasons first\n\nResponse fields\n\ncurrentlyActive describes if this is the active season in Profixio for this organisation." parameters: - in: query name: sportId description: 'Filter the result for a specific sport. BB, VB, FB etc. Must be at least 2 characters.' example: VB required: false schema: type: string description: 'Filter the result for a specific sport. BB, VB, FB etc. Must be at least 2 characters.' example: VB - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 751 name: 'Säsongen 2024/25' sportId: VB currentlyActive: true seasonStartDate: '2024-05-16' seasonEndDate: '2025-05-31' registrationStartDate: null registrationLastDate: null links: first: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/seasons?page=1' last: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/seasons?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/seasons?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/seasons' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 751 name: 'Säsongen 2024/25' sportId: VB currentlyActive: true seasonStartDate: '2024-05-16' seasonEndDate: '2025-05-31' registrationStartDate: null registrationLastDate: null items: type: object properties: id: type: integer example: 751 name: type: string example: 'Säsongen 2024/25' sportId: type: string example: VB currentlyActive: type: boolean example: true seasonStartDate: type: string example: '2024-05-16' seasonEndDate: type: string example: '2025-05-31' registrationStartDate: type: string example: null registrationLastDate: type: string example: null links: type: object properties: first: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/seasons?page=1' last: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/seasons?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/seasons?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/seasons' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Season parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SVBF.SE.SVB required: true schema: type: string '/api/seasons/{id}': get: summary: 'Season by Id' operationId: seasonById description: 'Return information about a specific season by Id' parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 765 name: adipisci sportId: FB currentlyActive: true seasonStartDate: '2024-05-23' seasonEndDate: '2024-03-24' registrationStartDate: '2024-02-01' registrationLastDate: '2024-02-24' properties: data: type: object properties: id: type: integer example: 765 name: type: string example: adipisci sportId: type: string example: FB currentlyActive: type: boolean example: true seasonStartDate: type: string example: '2024-05-23' seasonEndDate: type: string example: '2024-03-24' registrationStartDate: type: string example: '2024-02-01' registrationLastDate: type: string example: '2024-02-24' tags: - Season parameters: - in: path name: id description: 'The ID of the season.' example: architecto required: true schema: type: string '/api/seasons/{season_id}/tree': get: summary: 'The season tree' operationId: theSeasonTree description: 'Lists categories, divisions and tournaments for a season.' parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: type: object example: - id: 496 name: Förbundsserier level: 10 sport: BB belongsToDistrict: false adminDistrictId: null divisions: - id: 4533 name: Herrar belongsToDistrict: false adminDistrictId: null tournaments: - id: 30963 name: 'SBL Herr' slug: leagueid13505 webUrl: 'https://www.profixio.com/app/leagueid13505' matchCount: 196 belongsToDistrict: false adminDistrictId: null matchCategories: - id: 1124523 name: 'SBL Herr' categoryCode: 'SBL Herr' tags: - Season parameters: - in: path name: season_id description: 'The ID of the season.' example: 711 required: true schema: type: integer '/api/tournaments/{tournament_id}/playerStats': get: summary: Playerstatistics operationId: playerstatistics description: "Get player statistics in a series.\nThe player statistics are collected from the matches with livescore, after the match has finished." parameters: - in: query name: matchCategory description: 'Display where match category is equal to this value.' example: 3247289 required: false schema: type: integer description: 'Display where match category is equal to this value.' example: 3247289 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - teamId: 1301051 globalClubId: 886 tournamentId: 38611 teamName: Reingermouth personId: 971056 firstName: Esmeralda lastLame: Jacobson assists: 1 totalGoals: 5 gameGoals: 3 penaltyGoals: 2 games: 3 gamesPlayed: 2 - teamId: 1301052 globalClubId: 56600 tournamentId: 38618 teamName: Sydneeton personId: 971057 firstName: Brant lastLame: Dooley assists: 1 totalGoals: 5 gameGoals: 3 penaltyGoals: 2 games: 3 gamesPlayed: 2 properties: data: type: array example: - teamId: 1301051 globalClubId: 886 tournamentId: 38611 teamName: Reingermouth personId: 971056 firstName: Esmeralda lastLame: Jacobson assists: 1 totalGoals: 5 gameGoals: 3 penaltyGoals: 2 games: 3 gamesPlayed: 2 - teamId: 1301052 globalClubId: 56600 tournamentId: 38618 teamName: Sydneeton personId: 971057 firstName: Brant lastLame: Dooley assists: 1 totalGoals: 5 gameGoals: 3 penaltyGoals: 2 games: 3 gamesPlayed: 2 items: type: object properties: teamId: type: integer example: 1301051 globalClubId: type: integer example: 886 tournamentId: type: integer example: 38611 teamName: type: string example: Reingermouth personId: type: integer example: 971056 firstName: type: string example: Esmeralda lastLame: type: string example: Jacobson assists: type: integer example: 1 totalGoals: type: integer example: 5 gameGoals: type: integer example: 3 penaltyGoals: type: integer example: 2 games: type: integer example: 3 gamesPlayed: type: integer example: 2 tags: - Statistics parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/organisations/{organisation_id}/tournaments': get: summary: 'Tournaments in a organisation' operationId: tournamentsInAOrganisation description: "List of tournament (not leagues) for an organisation\n\nOnly lists tournament newer than 1 year ago.\n\n\nSorting: By start date, newest first" parameters: - in: query name: sportId description: 'Filter the result for a specific sport. BB, VB, FB etc. Must be at least 2 characters.' example: VB required: false schema: type: string description: 'Filter the result for a specific sport. BB, VB, FB etc. Must be at least 2 characters.' example: VB - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: query name: open_registration description: '1 = Display only tournaments with open registration' example: 16 required: false schema: type: integer description: '1 = Display only tournaments with open registration' example: 16 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 38285 name: 'Skåne Cup U16/18 Pojkar Deltävling 1 HT 2024' slug: skane-cup-u16-18-pojkar-deltevling-1-ht-2024 isTournament: true webUrl: 'https://www.profixio.com/app/skane-cup-u16-18-pojkar-deltevling-1-ht-2024' organisationId: SVBF.SE.SVB startDate: '2024-10-06' endDate: '2024-10-06' sportId: VB teamRegistrationConfig: registrationIsOpen: true registrationFromDate: '2024-08-19T19:46:00.000000Z' registrationLastDate: '2024-09-30T22:00:00.000000Z' publicDeadline: '2024-10-01T21:59:59.999999Z' address: street: '' postalCode: '' place: '' license: id: 3774 organisasjonsnr: '' name: 'Skånes Volleybollförbund' globalClubId: null matchCount: 0 links: first: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/tournaments?page=1' last: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/tournaments?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/tournaments?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/tournaments' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 38285 name: 'Skåne Cup U16/18 Pojkar Deltävling 1 HT 2024' slug: skane-cup-u16-18-pojkar-deltevling-1-ht-2024 isTournament: true webUrl: 'https://www.profixio.com/app/skane-cup-u16-18-pojkar-deltevling-1-ht-2024' organisationId: SVBF.SE.SVB startDate: '2024-10-06' endDate: '2024-10-06' sportId: VB teamRegistrationConfig: registrationIsOpen: true registrationFromDate: '2024-08-19T19:46:00.000000Z' registrationLastDate: '2024-09-30T22:00:00.000000Z' publicDeadline: '2024-10-01T21:59:59.999999Z' address: street: '' postalCode: '' place: '' license: id: 3774 organisasjonsnr: '' name: 'Skånes Volleybollförbund' globalClubId: null matchCount: 0 items: type: object properties: id: type: integer example: 38285 name: type: string example: 'Skåne Cup U16/18 Pojkar Deltävling 1 HT 2024' slug: type: string example: skane-cup-u16-18-pojkar-deltevling-1-ht-2024 isTournament: type: boolean example: true webUrl: type: string example: 'https://www.profixio.com/app/skane-cup-u16-18-pojkar-deltevling-1-ht-2024' organisationId: type: string example: SVBF.SE.SVB startDate: type: string example: '2024-10-06' endDate: type: string example: '2024-10-06' sportId: type: string example: VB teamRegistrationConfig: type: object properties: registrationIsOpen: type: boolean example: true registrationFromDate: type: string example: '2024-08-19T19:46:00.000000Z' registrationLastDate: type: string example: '2024-09-30T22:00:00.000000Z' publicDeadline: type: string example: '2024-10-01T21:59:59.999999Z' address: type: object properties: street: type: string example: '' postalCode: type: string example: '' place: type: string example: '' license: type: object properties: id: type: integer example: 3774 organisasjonsnr: type: string example: '' name: type: string example: 'Skånes Volleybollförbund' globalClubId: type: string example: null matchCount: type: integer example: 0 links: type: object properties: first: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/tournaments?page=1' last: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/tournaments?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/tournaments?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/organisations/SVBF.SE.SVB/tournaments' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Tournament parameters: - in: path name: organisation_id description: 'The ID of the organisation.' example: SVBF.SE.SVB required: true schema: type: string '/api/seasons/{season_id}/tournaments': get: summary: 'Tournaments in a season' operationId: tournamentsInASeason description: "List of tournaments/leagues for a season.\n\nCan be filtered by category and/or sport.\n\nTIP: Also see 'The season tree' endpoint to get all leagues, sorted under divisions and categories." parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: query name: categoryId description: 'The category the tournament belongs to.' example: 496 required: false schema: type: integer description: 'The category the tournament belongs to.' example: 496 - in: query name: sportId description: 'Filter the result for a specific sport.' example: BB required: false schema: type: string description: 'Filter the result for a specific sport.' example: BB - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 30963 name: 'SBL Herr' categoryId: 496 categoryName: Förbundsserier divisionId: 4533 divisionName: Herrar seasonId: 711 matchCount: 196 registrationTeamCount: 11 matchCategories: - id: 1124523 name: 'SBL Herr' categoryCode: 'SBL Herr' links: first: 'https://www.profixio.com/api/seasons/711/tournaments?page=1' last: 'https://www.profixio.com/api/seasons/711/tournaments?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/seasons/711/tournaments?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/seasons/711/tournaments' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 30963 name: 'SBL Herr' categoryId: 496 categoryName: Förbundsserier divisionId: 4533 divisionName: Herrar seasonId: 711 matchCount: 196 registrationTeamCount: 11 matchCategories: - id: 1124523 name: 'SBL Herr' categoryCode: 'SBL Herr' items: type: object properties: id: type: integer example: 30963 name: type: string example: 'SBL Herr' categoryId: type: integer example: 496 categoryName: type: string example: Förbundsserier divisionId: type: integer example: 4533 divisionName: type: string example: Herrar seasonId: type: integer example: 711 matchCount: type: integer example: 196 registrationTeamCount: type: integer example: 11 matchCategories: type: array example: - id: 1124523 name: 'SBL Herr' categoryCode: 'SBL Herr' items: type: object properties: id: type: integer example: 1124523 name: type: string example: 'SBL Herr' categoryCode: type: string example: 'SBL Herr' links: type: object properties: first: type: string example: 'https://www.profixio.com/api/seasons/711/tournaments?page=1' last: type: string example: 'https://www.profixio.com/api/seasons/711/tournaments?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/seasons/711/tournaments?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/seasons/711/tournaments' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Tournament parameters: - in: path name: season_id description: 'The ID of the season.' example: 711 required: true schema: type: integer '/api/tournaments/{id}': get: summary: 'Tournament by id' operationId: tournamentById description: 'Info about a tournament' parameters: - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 38619 name: 'aut adipisci quidem2024' slug: autadipisciquidem2024 isTournament: true webUrl: 'http://www.profixio.com/app/autadipisciquidem2024' organisationId: NFF.NO.FB countryId: 'NO' startDate: '2024-10-09' endDate: '2024-10-12' language: '' isDeactivated: false updatedAt: '2024-09-09T15:04:18.000000Z' isCancelled: false usesClub: true clubName: 'North Roderick' tournamentIsFinished: false tournamentHasStarted: false sport: id: FB name: Fotball sportsnamePublic: Fotball contactinfo: email: christian51@leffler.com address: '' postalCode: '06227' place: 'Lucienne Curve' phone: '' homepage: 'http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis' teamRegistrationConfig: registrationIsOpen: true registrationFromDate: null registrationLastDate: '2024-10-15T15:04:18.000000Z' publicDeadline: '2024-10-15T15:04:18.000000Z' hideRegistrationsPublic: false registrationsCount: 0 servicesConfig: registrationIsOpen: false hasServices: false deadline: '2024-10-18T22:00:00.000000Z' playerRegistrationConfig: registrationIsOpen: true deadline: '2024-10-17' refereeConfig: registrationIsOpen: false registrationStartDate: '2024-10-09' refereeRegistrationDeadline: null matchScheduleConfig: hideMatches: false status: UNPUBLISHED categoriesCount: '0' matchesCount: 0 properties: data: type: object properties: id: type: integer example: 38619 name: type: string example: 'aut adipisci quidem2024' slug: type: string example: autadipisciquidem2024 isTournament: type: boolean example: true webUrl: type: string example: 'http://www.profixio.com/app/autadipisciquidem2024' organisationId: type: string example: NFF.NO.FB countryId: type: string example: 'NO' startDate: type: string example: '2024-10-09' endDate: type: string example: '2024-10-12' language: type: string example: '' isDeactivated: type: boolean example: false updatedAt: type: string example: '2024-09-09T15:04:18.000000Z' isCancelled: type: boolean example: false usesClub: type: boolean example: true clubName: type: string example: 'North Roderick' tournamentIsFinished: type: boolean example: false tournamentHasStarted: type: boolean example: false sport: type: object properties: id: type: string example: FB name: type: string example: Fotball sportsnamePublic: type: string example: Fotball contactinfo: type: object properties: email: type: string example: christian51@leffler.com address: type: string example: '' postalCode: type: string example: '06227' place: type: string example: 'Lucienne Curve' phone: type: string example: '' homepage: type: string example: 'http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis' teamRegistrationConfig: type: object properties: registrationIsOpen: type: boolean example: true registrationFromDate: type: string example: null registrationLastDate: type: string example: '2024-10-15T15:04:18.000000Z' publicDeadline: type: string example: '2024-10-15T15:04:18.000000Z' hideRegistrationsPublic: type: boolean example: false registrationsCount: type: integer example: 0 servicesConfig: type: object properties: registrationIsOpen: type: boolean example: false hasServices: type: boolean example: false deadline: type: string example: '2024-10-18T22:00:00.000000Z' playerRegistrationConfig: type: object properties: registrationIsOpen: type: boolean example: true deadline: type: string example: '2024-10-17' refereeConfig: type: object properties: registrationIsOpen: type: boolean example: false registrationStartDate: type: string example: '2024-10-09' refereeRegistrationDeadline: type: string example: null matchScheduleConfig: type: object properties: hideMatches: type: boolean example: false status: type: string example: UNPUBLISHED categoriesCount: type: string example: '0' matchesCount: type: integer example: 0 tags: - Tournament parameters: - in: path name: id description: 'The ID of the tournament.' example: architecto required: true schema: type: string - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/tournaments/{tournament_id}/teams': get: summary: 'TeamRegistrations in a tournament' operationId: teamRegistrationsInATournament description: "Get teams registered in a tournament.\nThe team registrations are done before matches are published.\n\nThe id field here maps to teamRegistrationId on\nthe home and awayteams in a Match\n" parameters: - in: query name: players description: 'Include list of players for each team. Values: 0 = false, 1 = true.' example: false required: false schema: type: boolean description: 'Include list of players for each team. Values: 0 = false, 1 = true.' example: false - in: query name: seeding description: 'Include seeding number. Used for seeding in tournaments. For instance beach volley. Values: 0 = false, 1 = true.' example: false required: false schema: type: boolean description: 'Include seeding number. Used for seeding in tournaments. For instance beach volley. Values: 0 = false, 1 = true.' example: false - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 721480 name: 'Czech Republic' clubId: 175423 globalClubId: null registrationClass: 119453 registrationClassCode: M matchCategories: - id: 1102493 registrationLevel: null jersey: '' onWaitingList: false statusCode: 0 registeredAt: '2017-07-10T09:48:26.000000Z' deletedAt: null updatedAt: '2017-07-10 09:48:26' isDeactivatedInSchedule: false countryId: null registrationFeeStatus: isPaid: true baseFee: 0 discount: 0 amount: 0 paid: 0 serviceFeeStatus: isPaid: true amount: 0 ordersCount: 0 paid: 0 registrationComment: '' teamUrl: 'https://www.profixio.com/app/uefaeurosintef/teams/721480' links: first: 'https://www.profixio.com/api/tournaments/10/teams?page=1' last: 'https://www.profixio.com/api/tournaments/10/teams?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/teams?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/tournaments/10/teams' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 721480 name: 'Czech Republic' clubId: 175423 globalClubId: null registrationClass: 119453 registrationClassCode: M matchCategories: - id: 1102493 registrationLevel: null jersey: '' onWaitingList: false statusCode: 0 registeredAt: '2017-07-10T09:48:26.000000Z' deletedAt: null updatedAt: '2017-07-10 09:48:26' isDeactivatedInSchedule: false countryId: null registrationFeeStatus: isPaid: true baseFee: 0 discount: 0 amount: 0 paid: 0 serviceFeeStatus: isPaid: true amount: 0 ordersCount: 0 paid: 0 registrationComment: '' teamUrl: 'https://www.profixio.com/app/uefaeurosintef/teams/721480' items: type: object properties: id: type: integer example: 721480 name: type: string example: 'Czech Republic' clubId: type: integer example: 175423 globalClubId: type: string example: null registrationClass: type: integer example: 119453 registrationClassCode: type: string example: M matchCategories: type: array example: - id: 1102493 items: type: object properties: id: type: integer example: 1102493 registrationLevel: type: string example: null jersey: type: string example: '' onWaitingList: type: boolean example: false statusCode: type: integer example: 0 registeredAt: type: string example: '2017-07-10T09:48:26.000000Z' deletedAt: type: string example: null updatedAt: type: string example: '2017-07-10 09:48:26' isDeactivatedInSchedule: type: boolean example: false countryId: type: string example: null registrationFeeStatus: type: object properties: isPaid: type: boolean example: true baseFee: type: integer example: 0 discount: type: integer example: 0 amount: type: integer example: 0 paid: type: integer example: 0 serviceFeeStatus: type: object properties: isPaid: type: boolean example: true amount: type: integer example: 0 ordersCount: type: integer example: 0 paid: type: integer example: 0 registrationComment: type: string example: '' teamUrl: type: string example: 'https://www.profixio.com/app/uefaeurosintef/teams/721480' links: type: object properties: first: type: string example: 'https://www.profixio.com/api/tournaments/10/teams?page=1' last: type: string example: 'https://www.profixio.com/api/tournaments/10/teams?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/teams?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/tournaments/10/teams' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Tournament parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/tournaments/{tournament_id}/globalTeams': get: summary: 'GlobalTeams in a tournament' operationId: globalTeamsInATournament description: "Get teams for a tournament for Leagues which do not use TeamRegistration.\n\nThe id field here maps to globalTeamId on\nthe home and awayteams in a Match\n\n" parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 14655 name: 'Broberg/Söderhamn IF' globalClubId: 23175 links: first: 'https://www.profixio.com/api/tournaments/10/globalTeams?page=1' last: 'https://www.profixio.com/api/tournaments/10/globalTeams?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/globalTeams?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/tournaments/10/globalTeams' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 14655 name: 'Broberg/Söderhamn IF' globalClubId: 23175 items: type: object properties: id: type: integer example: 14655 name: type: string example: 'Broberg/Söderhamn IF' globalClubId: type: integer example: 23175 links: type: object properties: first: type: string example: 'https://www.profixio.com/api/tournaments/10/globalTeams?page=1' last: type: string example: 'https://www.profixio.com/api/tournaments/10/globalTeams?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/globalTeams?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/tournaments/10/globalTeams' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Tournament parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/tournaments/{tournament_id}/clubs': get: summary: 'Clubs in a tournament' operationId: clubsInATournament description: "Get clubs for a tournament.\nOnly returns clubs that has teamRegistrations" parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 175423 name: NoName globalClubId: null tournamentId: 10 countryId: null links: first: 'https://www.profixio.com/api/tournaments/10/clubs?page=1' last: 'https://www.profixio.com/api/tournaments/10/clubs?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/clubs?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/tournaments/10/clubs' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 175423 name: NoName globalClubId: null tournamentId: 10 countryId: null items: type: object properties: id: type: integer example: 175423 name: type: string example: NoName globalClubId: type: string example: null tournamentId: type: integer example: 10 countryId: type: string example: null links: type: object properties: first: type: string example: 'https://www.profixio.com/api/tournaments/10/clubs?page=1' last: type: string example: 'https://www.profixio.com/api/tournaments/10/clubs?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/clubs?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/tournaments/10/clubs' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Tournament parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/tournaments/{tournament_id}/matchCategories': get: summary: 'MatchCategories in a tournament' operationId: matchCategoriesInATournament description: "Get MatchCategories for a tournament.\n\nA matchcategory can have:\n- MatchGroups (Pulje)\n- MatchLeagues (SluttspillSerie / MellomspillSerie)\n- Playoff (Sluttspill)\n\nIn Playoffs the teams are automatically placed based on the results from the group and league matches.\n\nExample:\n\n\"MatchCategory\"" parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 1102493 name: Men categoryCode: M numberOfSets: 0 sortOrder: 0 matchlength: 15 matchtableUpdatedAt: '2019-09-03T15:11:09.000000Z' matchTableIsHidden: false numberOfPeriods: 1 isHidden: false hideResults: false gender: M minutesPerPeriod: 1 poolPlay: 0 matchGroups: - id: 3247288 matchCategoryId: 1102493 displayName: A name: '1' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247289 matchCategoryId: 1102493 displayName: B name: '2' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247290 matchCategoryId: 1102493 displayName: C name: '3' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247291 matchCategoryId: 1102493 displayName: D name: '4' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' matchLeagues: - id: 3313 name: 'L A' sortOrder: 100 - id: 3311 name: 'L B' sortOrder: 100 - id: 3312 name: 'L C' sortOrder: 100 playoffTrees: - id: 55087 published: true name: '' number: 1 links: first: 'https://www.profixio.com/api/tournaments/10/matchCategories?page=1' last: 'https://www.profixio.com/api/tournaments/10/matchCategories?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/matchCategories?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/tournaments/10/matchCategories' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 1102493 name: Men categoryCode: M numberOfSets: 0 sortOrder: 0 matchlength: 15 matchtableUpdatedAt: '2019-09-03T15:11:09.000000Z' matchTableIsHidden: false numberOfPeriods: 1 isHidden: false hideResults: false gender: M minutesPerPeriod: 1 poolPlay: 0 matchGroups: - id: 3247288 matchCategoryId: 1102493 displayName: A name: '1' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247289 matchCategoryId: 1102493 displayName: B name: '2' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247290 matchCategoryId: 1102493 displayName: C name: '3' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247291 matchCategoryId: 1102493 displayName: D name: '4' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' matchLeagues: - id: 3313 name: 'L A' sortOrder: 100 - id: 3311 name: 'L B' sortOrder: 100 - id: 3312 name: 'L C' sortOrder: 100 playoffTrees: - id: 55087 published: true name: '' number: 1 items: type: object properties: id: type: integer example: 1102493 name: type: string example: Men categoryCode: type: string example: M numberOfSets: type: integer example: 0 sortOrder: type: integer example: 0 matchlength: type: integer example: 15 matchtableUpdatedAt: type: string example: '2019-09-03T15:11:09.000000Z' matchTableIsHidden: type: boolean example: false numberOfPeriods: type: integer example: 1 isHidden: type: boolean example: false hideResults: type: boolean example: false gender: type: string example: M minutesPerPeriod: type: integer example: 1 poolPlay: type: integer example: 0 matchGroups: type: array example: - id: 3247288 matchCategoryId: 1102493 displayName: A name: '1' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247289 matchCategoryId: 1102493 displayName: B name: '2' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247290 matchCategoryId: 1102493 displayName: C name: '3' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' - id: 3247291 matchCategoryId: 1102493 displayName: D name: '4' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' items: type: object properties: id: type: integer example: 3247288 matchCategoryId: type: integer example: 1102493 displayName: type: string example: A name: type: string example: '1' sortOrder: type: integer example: 0 matchtableUpdatedAt: type: string example: '0000-12-31T23:17:00.000000Z' matchLeagues: type: array example: - id: 3313 name: 'L A' sortOrder: 100 - id: 3311 name: 'L B' sortOrder: 100 - id: 3312 name: 'L C' sortOrder: 100 items: type: object properties: id: type: integer example: 3313 name: type: string example: 'L A' sortOrder: type: integer example: 100 playoffTrees: type: array example: - id: 55087 published: true name: '' number: 1 items: type: object properties: id: type: integer example: 55087 published: type: boolean example: true name: type: string example: '' number: type: integer example: 1 links: type: object properties: first: type: string example: 'https://www.profixio.com/api/tournaments/10/matchCategories?page=1' last: type: string example: 'https://www.profixio.com/api/tournaments/10/matchCategories?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/matchCategories?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/tournaments/10/matchCategories' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Tournament parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/tournaments/{tournament_id}/matchGroups': get: summary: 'MatchGroups in a tournament' operationId: matchGroupsInATournament description: "Get the MatchGroups in a tournament.\nEach MatchGroup belongs to a MatchCategory" parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 3247288 matchCategoryId: 1102493 displayName: A name: '1' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' links: first: 'https://www.profixio.com/api/tournaments/10/matchGroups?page=1' last: 'https://www.profixio.com/api/tournaments/10/matchGroups?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/matchGroups?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/tournaments/10/matchGroups' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 3247288 matchCategoryId: 1102493 displayName: A name: '1' sortOrder: 0 matchtableUpdatedAt: '0000-12-31T23:17:00.000000Z' items: type: object properties: id: type: integer example: 3247288 matchCategoryId: type: integer example: 1102493 displayName: type: string example: A name: type: string example: '1' sortOrder: type: integer example: 0 matchtableUpdatedAt: type: string example: '0000-12-31T23:17:00.000000Z' links: type: object properties: first: type: string example: 'https://www.profixio.com/api/tournaments/10/matchGroups?page=1' last: type: string example: 'https://www.profixio.com/api/tournaments/10/matchGroups?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/10/matchGroups?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/tournaments/10/matchGroups' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Tournament parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 10 required: true schema: type: integer '/api/tournaments/{tournament_id}/arenas': get: summary: 'Arenas for a tournament' operationId: arenasForATournament description: "Get the arenas for a tournament. The arenas are grouped by match category,\nand by match groups." parameters: - in: query name: limit description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 required: false schema: type: integer description: 'The number of records per page. Must be at least 1. Must not be greater than 500.' example: 15 - in: query name: page description: 'The page number of the paginated result. Must be at least 1.' example: 1 required: false schema: type: integer description: 'The page number of the paginated result. Must be at least 1.' example: 1 - in: header name: X-Api-Secret description: '' example: '{YOUR_AUTH_KEY}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 198159 name: 'Älta IP' fields: - id: 1193360 name: 'Plan 2' - id: 1193361 name: 'Plan 3' links: first: 'https://www.profixio.com/api/tournaments/6/arenas?page=1' last: 'https://www.profixio.com/api/tournaments/6/arenas?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/6/arenas?page=1' label: '1' active: true - url: null label: Next active: false path: 'https://www.profixio.com/api/tournaments/6/arenas' per_page: 15 to: 1 total: 1 properties: data: type: array example: - id: 198159 name: 'Älta IP' fields: - id: 1193360 name: 'Plan 2' - id: 1193361 name: 'Plan 3' items: type: object properties: id: type: integer example: 198159 name: type: string example: 'Älta IP' fields: type: array example: - id: 1193360 name: 'Plan 2' - id: 1193361 name: 'Plan 3' items: type: object properties: id: type: integer example: 1193360 name: type: string example: 'Plan 2' links: type: object properties: first: type: string example: 'https://www.profixio.com/api/tournaments/6/arenas?page=1' last: type: string example: 'https://www.profixio.com/api/tournaments/6/arenas?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: Prev active: false - url: 'https://www.profixio.com/api/tournaments/6/arenas?page=1' label: '1' active: true - url: null label: Next active: false items: type: object properties: url: type: string example: null label: type: string example: Prev active: type: boolean example: false path: type: string example: 'https://www.profixio.com/api/tournaments/6/arenas' per_page: type: integer example: 15 to: type: integer example: 1 total: type: integer example: 1 tags: - Tournament parameters: - in: path name: tournament_id description: 'The ID of the tournament.' example: 6 required: true schema: type: integer tags: - name: Endpoints description: '' - name: Matches description: '' - name: Organisation description: '' - name: Ranking description: '' - name: Season description: '' - name: Statistics description: '' - name: Tournament description: '' components: securitySchemes: default: type: apiKey name: X-Api-Secret in: header description: 'Contact Profixio to get an API token.' security: - default: []