# Participant

Endpoint to retrieve data for participants.

## Finds participants by filtering a specific conference(frame)

> Gets \`Participant\` objects.

```json
{"openapi":"3.1.1","info":{"title":"Converia API","version":"2.15.0"},"tags":[{"name":"Participant","description":"Endpoint to retrieve data for participants."}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"description":"Api key has to be used to authenticate against the server. The token parameter has must be sent in the header","type":"apiKey","name":"token","in":"header"}},"schemas":{"Participant":{"type":"object","description":"None required fields can be empty. Additional fields like badge is nullable.","required":["id","firstname","lastname"],"properties":{"id":{"description":"Primary id of the person record in Converia","type":"integer"},"firstname":{"description":"Firstname of the participant","type":"string"},"lastname":{"description":"Lastname of the participant","type":"string"},"title":{"description":"Academic title of the participant","type":"string"},"foa":{"description":"Form of address of the participant","type":"string"},"email":{"description":"Email address of the participant","type":"string"},"company":{"description":"Company or Institution of the participant","type":"string"},"department":{"description":"Department of the participant","type":"string"},"phone":{"description":"Phone number of the participant","type":"string"},"city":{"description":"City of the participant","type":"string"},"street":{"description":"Street of the participant","type":"string"},"zip":{"description":"Zip/postcode of the participant","type":"string"},"country":{"description":"Country of the participant","type":"string","format":"ISO 3166-1 alpha-2 codes"},"language":{"description":"Language of the participant","type":"string","format":"ISO 639-1"},"booking-state":{"description":"Booking state of the participant. Possible states are \"valid\" and \"canceled\".","enum":["valid","canceled"],"type":"string"},"booking-barcode":{"description":"Contains the value of the booking barcode. It's only displayed if \"booking-state\" is of state \"valid\".","type":"string"},"merged-from":{"description":"List of person ids that where merged to this person entry.","type":"array","items":{"type":"integer"}},"efn":{"description":"Stored efn for the participant. Default empty string.","type":"string"},"member":{"description":"Link to member entries connected this participant, only loaded if \"member\" is appended to the include request parameter.","type":"array","items":{"$ref":"#/components/schemas/Member"}},"cart-event":{"description":"List of booked events this participant, only loaded if \"cart-event\" is appended to the include request parameter.","type":"array","items":{"$ref":"#/components/schemas/Event"}},"badge":{"$ref":"#/components/schemas/Badge"},"eav":{"description":"List of eav values","type":"array","items":{"$ref":"#/components/schemas/EavEntry"}}}},"Member":{"description":"Represents the member entity in Converia. Participant can be associated to multiple member entries.","type":"object","required":["id"],"properties":{"id":{"description":"Primary id of the member record in Converia","type":"integer"},"external-reference":{"description":"External identifier stored in Converia for a specific member.","type":"string"},"number":{"description":"Member id stored in Converia. This id is normally imported into Converia","type":"string"}}},"Event":{"type":"object","description":"Represents an event entity in Converia. An event in this case in an abstraction of concrete purchased items.","required":["id"],"properties":{"id":{"description":"Primary id of the event record in Converia","type":"integer"},"external-reference":{"description":"External identifier stored in Converia for a specific event.","type":"string"},"name":{"description":"Name of the event.","type":"string"}}},"Badge":{"description":"Represents the badge entity in Converia. Participant can have a badge with a specific number.","type":"object","required":["id"],"properties":{"id":{"description":"Primary id of the badge record in Converia","type":"integer"},"number":{"description":"Unique badge number. A person can only have one valid badge number per conference. This number is printed as scanable code on the printed badge and is then scanned on the checkin.","type":"string"},"printTime":{"description":"Time when the badge was printed the last time. Property will be ommitted if badge is not printed.","type":"string","format":"ISO-8601"}}},"EavEntry":{"type":"object","description":"Represents an eav entry connect with the person.","required":["key","value"],"properties":{"key":{"description":"Internal name of the eav attribute","type":"string"},"value":{"description":"Value for the given eav value, will be converted to string in any case","type":"string"}}},"ErrorResult":{"type":"object","description":"Result format in an error case.","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","description":"Format of an error.","required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/rest-api/v2/frame/{id}/participant/":{"get":{"tags":["Participant"],"description":"Gets `Participant` objects.","summary":"Finds participants by filtering a specific conference(frame)","parameters":[{"schema":{"type":"integer","format":"int64"},"name":"id","in":"path","description":"Id of the conference the participants are loaded for.","required":true},{"schema":{"type":"string","format":"ISO-8601"},"name":"changed-after","in":"query","description":"Filter to limit returned participant list to participants changed after this date (not including the given timestamp itself).","required":false},{"schema":{"type":"string","enum":["efn","cart-event","member","badge","eav"]},"name":"include","in":"query","description":"Comma separated list of related or additional data that should be fetched as well.","required":false}],"responses":{"200":{"description":"Successful response","headers":{"X-Rate-Limit-Interval":{"schema":{"type":"integer"},"description":"Interval of a time window in seconds"},"X-Rate-Limit-Reset":{"schema":{"type":"integer"},"description":"The remaining window before the credit limit resets in seconds"},"X-Rate-Limit-Remaining":{"schema":{"type":"integer"},"description":"The number of credits left for the time window"},"X-Rate-Limit-Limit":{"schema":{"type":"integer"},"description":"Credit limit per time window"}},"content":{"application/json":{"schema":{"title":"Result Record","type":"object","required":["data"],"properties":{"meta":{"type":"object","properties":{"changed-until":{"type":"string","description":"Time until which data has been fetched. Including the timestamp itself.","format":"ISO-8601"}}},"data":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Authentication problem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"No resource found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"429":{"description":"Rate limitation exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}}}}}}}
```