{"openapi":"3.0.0","info":{"title":"HireSweet API","version":"1.0.0"},"paths":{"/api/v1/deals":{"get":{"description":"List deals with filtering and sorting","summary":"Retrieve deals with advanced filtering, sorting, and pagination","tags":["Deals"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Type of the deal (e.g., invoices)","example":"invoices"},"required":false,"description":"Type of the deal (e.g., invoices)","name":"type","in":"query"},{"schema":{"type":"string","description":"Include deleted deals in the results","example":"true"},"required":false,"description":"Include deleted deals in the results","name":"include_deleted","in":"query"},{"schema":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"required":false,"description":"Number of results per page (1-100)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"required":false,"description":"Filter results created after this date","name":"created_after","in":"query"},{"schema":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"required":false,"description":"Filter results created strictly before this date","name":"created_before","in":"query"},{"schema":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"required":false,"description":"Filter results updated after this date","name":"updated_after","in":"query"},{"schema":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"required":false,"description":"Filter results updated strictly before this date","name":"updated_before","in":"query"},{"schema":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"required":false,"description":"Pagination cursor for next page","name":"cursor","in":"query"},{"schema":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Deal's creation date</li><li><b>updated_at</b>: Deal's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"},"required":false,"description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Deal's creation date</li><li><b>updated_at</b>: Deal's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","name":"sort","in":"query"}],"responses":{"200":{"description":"List of deals","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDealsResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/deals/:dealId":{"get":{"description":"Retrieve a specific deal by its ID","summary":"Get deal details","tags":["Deals"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The unique identifier of the deal"},"required":true,"description":"The unique identifier of the deal","name":"dealId","in":"path"}],"responses":{"200":{"description":"Deal details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/projects":{"get":{"description":"List projects with filtering and sorting","summary":"Retrieve projects with advanced filtering, sorting, and pagination","tags":["Projects"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"required":false,"description":"Number of results per page (1-100)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"required":false,"description":"Filter results created after this date","name":"created_after","in":"query"},{"schema":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"required":false,"description":"Filter results created strictly before this date","name":"created_before","in":"query"},{"schema":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"required":false,"description":"Filter results updated after this date","name":"updated_after","in":"query"},{"schema":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"required":false,"description":"Filter results updated strictly before this date","name":"updated_before","in":"query"},{"schema":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"required":false,"description":"Pagination cursor for next page","name":"cursor","in":"query"},{"schema":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Project's creation date</li><li><b>updated_at</b>: Project's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"},"required":false,"description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Project's creation date</li><li><b>updated_at</b>: Project's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","name":"sort","in":"query"}],"responses":{"200":{"description":"List of projects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProjectsResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/projects/:projectId":{"get":{"description":"Get a project by its ID","summary":"Retrieve a specific project using its unique identifier","tags":["Projects"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"$ref":"#/components/schemas/The unique identifier of the project"},"required":true,"name":"projectId","in":"path"}],"responses":{"200":{"description":"Project details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/contacts":{"get":{"description":"List contacts with filtering and sorting","summary":"Retrieve contacts with advanced filtering, sorting, and pagination","tags":["Contacts"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"required":false,"description":"Number of results per page (1-100)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"required":false,"description":"Filter results created after this date","name":"created_after","in":"query"},{"schema":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"required":false,"description":"Filter results created strictly before this date","name":"created_before","in":"query"},{"schema":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"required":false,"description":"Filter results updated after this date","name":"updated_after","in":"query"},{"schema":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"required":false,"description":"Filter results updated strictly before this date","name":"updated_before","in":"query"},{"schema":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"required":false,"description":"Pagination cursor for next page","name":"cursor","in":"query"},{"schema":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Contact's creation date</li><li><b>updated_at</b>: Contact's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"},"required":false,"description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Contact's creation date</li><li><b>updated_at</b>: Contact's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","name":"sort","in":"query"}],"responses":{"200":{"description":"List of contacts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedContactsResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/contacts/:contactId":{"get":{"description":"Get a contact by ID","summary":"Retrieve a specific contact using its unique identifier","tags":["Contacts"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Unique identifier of the contact"},"required":true,"description":"Unique identifier of the contact","name":"contactId","in":"path"}],"responses":{"200":{"description":"Contact details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/users":{"get":{"description":"List users with filtering and sorting","summary":"Retrieve users with advanced filtering, sorting, and pagination","tags":["Users"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"required":false,"description":"Number of results per page (1-100)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"required":false,"description":"Filter results created after this date","name":"created_after","in":"query"},{"schema":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"required":false,"description":"Filter results created strictly before this date","name":"created_before","in":"query"},{"schema":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"required":false,"description":"Filter results updated after this date","name":"updated_after","in":"query"},{"schema":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"required":false,"description":"Filter results updated strictly before this date","name":"updated_before","in":"query"},{"schema":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"required":false,"description":"Pagination cursor for next page","name":"cursor","in":"query"},{"schema":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: User's creation date</li><li><b>updated_at</b>: User's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"},"required":false,"description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: User's creation date</li><li><b>updated_at</b>: User's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedUsersResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/users/:userId":{"get":{"description":"Get a user by ID","summary":"Retrieve a single user by their unique ID","tags":["Users"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"$ref":"#/components/schemas/The unique identifier of the user"},"required":true,"name":"userId","in":"path"}],"responses":{"200":{"description":"User details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/companies":{"get":{"description":"List companies with filtering and sorting","summary":"Retrieve companies with advanced filtering, sorting, and pagination","tags":["Companies"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"required":false,"description":"Number of results per page (1-100)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"required":false,"description":"Filter results created after this date","name":"created_after","in":"query"},{"schema":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"required":false,"description":"Filter results created strictly before this date","name":"created_before","in":"query"},{"schema":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"required":false,"description":"Filter results updated after this date","name":"updated_after","in":"query"},{"schema":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"required":false,"description":"Filter results updated strictly before this date","name":"updated_before","in":"query"},{"schema":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"required":false,"description":"Pagination cursor for next page","name":"cursor","in":"query"},{"schema":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Company's creation date</li><li><b>updated_at</b>: Company's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"},"required":false,"description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Company's creation date</li><li><b>updated_at</b>: Company's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","name":"sort","in":"query"}],"responses":{"200":{"description":"List of companies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCompaniesResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/companies/:companyId":{"get":{"description":"Retrieve a single company by its ID","summary":"Get company details","tags":["Companies"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Unique identifier for the company","example":"company-123"},"required":true,"description":"Unique identifier for the company","name":"companyId","in":"path"}],"responses":{"200":{"description":"Company details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/activities":{"get":{"description":"List activities with filtering and sorting","summary":"Retrieve activities with advanced filtering, sorting, and pagination","tags":["Activities"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Type of the activity (e.g., invoices)","example":"invoices"},"required":false,"description":"Type of the activity (e.g., invoices)","name":"type","in":"query"},{"schema":{"type":"string","description":"Include deleted activities in the results","example":"true"},"required":false,"description":"Include deleted activities in the results","name":"include_deleted","in":"query"},{"schema":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"required":false,"description":"Number of results per page (1-100)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"required":false,"description":"Filter results created after this date","name":"created_after","in":"query"},{"schema":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"required":false,"description":"Filter results created strictly before this date","name":"created_before","in":"query"},{"schema":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"required":false,"description":"Filter results updated after this date","name":"updated_after","in":"query"},{"schema":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"required":false,"description":"Filter results updated strictly before this date","name":"updated_before","in":"query"},{"schema":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"required":false,"description":"Pagination cursor for next page","name":"cursor","in":"query"},{"schema":{"type":"string","default":"created_at:desc","description":"<div>\n  Sort order (field:direction).<br/>\n  Field can be:\n  <ul>\n    <li><b>created_at</b>: Activity's creation date</li>\n    <li><b>updated_at</b>: Activity's last update date</li>\n    <li><b>date</b>: Date of the activity</li>\n    <li><b>meeting_start_dates</b>: For calendar meetings, date of the start of the meeting</li>\n  </ul>\n  Direction can be:\n  <ul>\n    <li><b>asc</b>: ascending</li>\n    <li><b>desc</b>: descending</li>\n  </ul>\n</div>","example":"created_at:desc"},"required":false,"description":"<div>\n  Sort order (field:direction).<br/>\n  Field can be:\n  <ul>\n    <li><b>created_at</b>: Activity's creation date</li>\n    <li><b>updated_at</b>: Activity's last update date</li>\n    <li><b>date</b>: Date of the activity</li>\n    <li><b>meeting_start_dates</b>: For calendar meetings, date of the start of the meeting</li>\n  </ul>\n  Direction can be:\n  <ul>\n    <li><b>asc</b>: ascending</li>\n    <li><b>desc</b>: descending</li>\n  </ul>\n</div>","name":"sort","in":"query"}],"responses":{"200":{"description":"List of activities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedActivitiesResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/activities/:activityId":{"get":{"description":"Get activity by ID","summary":"Retrieve a specific activity by its ID","tags":["Activities"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The unique identifier of the activity"},"required":true,"description":"The unique identifier of the activity","name":"activityId","in":"path"}],"responses":{"200":{"description":"Activity details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/job-postings":{"get":{"description":"List job postings with filtering and pagination","summary":"Retrieve job postings with filtering, sorting, and pagination","tags":["Job Postings"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"Filter by published status","example":"true"},"required":false,"description":"Filter by published status","name":"published","in":"query"},{"schema":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"required":false,"description":"Number of results per page (1-100)","name":"limit","in":"query"},{"schema":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"required":false,"description":"Filter results created after this date","name":"created_after","in":"query"},{"schema":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"required":false,"description":"Filter results created strictly before this date","name":"created_before","in":"query"},{"schema":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"required":false,"description":"Filter results updated after this date","name":"updated_after","in":"query"},{"schema":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"required":false,"description":"Filter results updated strictly before this date","name":"updated_before","in":"query"},{"schema":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"required":false,"description":"Pagination cursor for next page","name":"cursor","in":"query"},{"schema":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Job posting's creation date</li><li><b>updated_at</b>: Job posting's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"},"required":false,"description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Job posting's creation date</li><li><b>updated_at</b>: Job posting's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","name":"sort","in":"query"}],"responses":{"200":{"description":"List of job postings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedJobPostingsResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}},"/api/v1/job-postings/:jobPostingId":{"get":{"description":"Retrieve a specific job posting by its ID","summary":"Get job posting details","tags":["Job Postings"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The unique identifier of the job posting"},"required":true,"description":"The unique identifier of the job posting","name":"jobPostingId","in":"path"}],"responses":{"200":{"description":"Job posting details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobPostingResponse"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid cursor format","code":"INVALID_CURSOR"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Rate limit exceeded","code":"RATE_LIMIT_EXCEEDED"}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication"}},"schemas":{"ApiError":{"type":"object","properties":{"error":{"type":"string","description":"Error message","example":"Invalid or missing API key"},"code":{"type":"string","description":"Error code","example":"UNAUTHORIZED"},"details":{"nullable":true,"description":"Additional error details"},"request_id":{"type":"string","description":"Request identifier for tracking"}},"required":["error","code"]},"DealsQueryParams":{"type":"object","properties":{"type":{"type":"string","description":"Type of the deal (e.g., invoices)","example":"invoices"},"include_deleted":{"type":"string","description":"Include deleted deals in the results","example":"true"},"limit":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"created_after":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"created_before":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"updated_after":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"updated_before":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"cursor":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"sort":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Deal's creation date</li><li><b>updated_at</b>: Deal's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"}},"title":"Get Deals Query Parameters","description":"Parameters for retrieving deals with filtering, sorting, and pagination"},"DealResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the deal","example":"deal-123"},"is_deleted":{"type":"boolean","description":"true if the deal has been deleted and is no longer accessible in the app, false otherwise","example":false},"type":{"type":"string","description":"Type of the deal","example":"job_posting"},"created_by":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user who created the deal","example":"user-456"},"email":{"type":"string","format":"email","description":"Email of the user who created the deal","example":"john.doe@hiresweet.com"}},"required":["id","email"],"description":"User who created the deal","example":{"id":"user-456","email":"john.doe@hiresweet.com"}},"owned_by":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user who created the deal","example":"user-456"},"email":{"type":"string","format":"email","description":"Email of the user who created the deal","example":"john.doe@hiresweet.com"}},"required":["id","email"],"description":"User who created the deal","example":{"id":"user-456","email":"john.doe@hiresweet.com"}},"custom_fields":{"type":"array","items":{"type":"object","properties":{"custom_field_id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["custom_field_id","type","value"]},"description":"Custom fields associated with the deal","examples":[[{"custom_field_id":"qualifications","type":"enum","value":"JavaScript, TypeScript, Node.js"},{"custom_field_id":"experience","type":"number","value":"5"}]]},"state":{"type":"object","properties":{"status":{"type":"string","enum":["pending","active","success","archived"],"description":"Current status of the deal","example":"active"},"stage_id":{"type":"string","description":"ID of the current stage in the deal pipeline","example":"proposed"},"history":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["created","stage-updated"],"description":"Type of event","example":"stage-updated"},"date":{"type":"string","description":"ISO 8601 event date","example":"2025-01-15T10:30:00.000Z"},"status":{"type":"string","enum":["pending","active","success","archived"],"description":"Status after the state change","example":"active"},"stage_id":{"type":"string","description":"Stage ID after the state change","example":"accepted"},"user":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","format":"email"}},"required":["id","email"],"description":"User who made the state change"}},"required":["type","date","status","stage_id","user"]},"description":"History of state changes for the deal","example":[{"type":"created","date":"2025-01-10T10:30:00.000Z","status":"pending","stage_id":"waiting-for-review","user":{"id":"am9obi5kb2VAaGlyZXN3ZWV0LmNvbQ==","email":"john.doe@hiresweet.com"}},{"type":"stage-updated","date":"2025-01-15T10:30:00.000Z","status":"active","stage_id":"proposed","user":{"id":"am9obi5kb2VAaGlyZXN3ZWV0LmNvbQ==","email":"john.doe@hiresweet.com"}}]}},"required":["status","stage_id","history"],"description":"Current state of the deal"},"title":{"type":"string","description":"Title of the deal","example":"Senior Developer"},"revenue":{"type":"object","nullable":true,"properties":{"value":{"type":"number","description":"Numerical amount in case of success","example":123.45}},"required":["value"],"description":"Revenue of the deal in case of success"},"expected_close_date":{"type":"string","nullable":true,"description":"ISO 8601 expected closing date for the deal","example":"2024-02-15T00:00:00.000Z"},"linked_users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","format":"email"},"attribution_ratio":{"type":"number","nullable":true}},"required":["id","email","attribution_ratio"]},"description":"List of users linked to the deal, with attribution ratio if defined","example":[{"id":"am9obi5kb2VAaGlyZXN3ZWV0LmNvbQ==","email":"john.doe@hiresweet.com","attribution_ratio":0.6}]},"linked_companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"description":"List of companies linked to the deal","example":[{"id":"company-123"}]},"linked_projects":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"description":"List of projects linked to the deal","example":[{"id":"project-123"}]},"linked_contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"roleId":{"type":"string"}},"required":["id"]},"description":"List of contacts linked to the deal","example":[{"id":"contact-123","roleId":"manager"}]},"created_at":{"type":"string","description":"ISO 8601 creation date","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","description":"ISO 8601 last modification date","example":"2024-01-20T14:45:32.123Z"}},"required":["id","is_deleted","type","created_by","owned_by","custom_fields","state","title","revenue","expected_close_date","linked_users","linked_companies","linked_projects","linked_contacts","created_at","updated_at"]},"PaginatedDealsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DealResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"Pagination":{"type":"object","properties":{"limit":{"type":"number","description":"Number of results per page","example":20},"has_next_page":{"type":"boolean","description":"Whether there is a next page","example":true},"has_previous_page":{"type":"boolean","description":"Whether there is a previous page","example":false},"next_cursor":{"type":"string","nullable":true,"description":"Cursor for the next page","example":"eyJ0aW1lc3RhbXAi..."},"previous_cursor":{"type":"string","description":"Cursor for the previous page"}},"required":["limit","has_next_page","next_cursor"]},"ProjectsQueryParams":{"type":"object","properties":{"limit":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"created_after":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"created_before":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"updated_after":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"updated_before":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"cursor":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"sort":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Project's creation date</li><li><b>updated_at</b>: Project's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"}},"title":"Get Projects Query Parameters","description":"Parameters for retrieving projects with filtering, sorting, and pagination"},"ProjectResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the project","example":"project_123"},"created_by":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user who created the project","example":"user-456"},"email":{"type":"string","format":"email","description":"Email of the user who created the project","example":"john.doe@hiresweet.com"}},"required":["id","email"],"description":"User who created the project","example":{"id":"user-456","email":"john.doe@hiresweet.com"}},"owned_by":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user who created the project","example":"user-456"},"email":{"type":"string","format":"email","description":"Email of the user who created the project","example":"john.doe@hiresweet.com"}},"required":["id","email"],"description":"User who created the project","example":{"id":"user-456","email":"john.doe@hiresweet.com"}},"title":{"type":"string","description":"Title of the project","example":"Senior Developer"},"position_description":{"type":"string","nullable":true,"description":"Description of the (job) position of the project","example":"Senior Developer with 4+ years of experience"},"status":{"type":"string","enum":["active","archived"],"description":"Status of the project (active or archived)","example":"archived"},"linked_companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"description":"List of companies linked to the project","example":[{"id":"company-123","name":"Acme"}]},"created_at":{"type":"string","description":"ISO 8601 creation date","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","description":"ISO 8601 last modification date","example":"2024-01-20T14:45:32.123Z"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"custom_field_id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["custom_field_id","type","value"]},"description":"Custom fields associated with the deal","examples":[[{"custom_field_id":"qualifications","type":"enum","value":"JavaScript, TypeScript, Node.js"},{"custom_field_id":"experience","type":"number","value":"5"}]]},"department":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"description":"Department the project is assigned to","example":{"id":"normandie","name":"Acme Normandie"}},"section":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"description":"Section the project is assigned to","example":{"id":"caen","name":"Acme Caen"}},"subsection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"description":"Subsection the project is assigned to","example":{"id":"caen_experts","name":"Acme Caen - Experts"}}},"required":["id","created_by","owned_by","title","position_description","status","linked_companies","created_at","updated_at","custom_fields"]},"PaginatedProjectsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProjectResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"ContactsQueryParams":{"type":"object","properties":{"limit":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"created_after":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"created_before":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"updated_after":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"updated_before":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"cursor":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"sort":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Contact's creation date</li><li><b>updated_at</b>: Contact's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"}},"title":"Get Contacts Query Parameters","description":"Parameters for retrieving contacts with filtering, sorting, and pagination"},"ContactResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the contact","example":"contact_123"},"firstname":{"type":"string","description":"First name of the contact","example":"John"},"lastname":{"type":"string","description":"Last name of the contact","example":"Doe"},"categories":{"type":"array","items":{"type":"string","enum":["candidate","business-contact"]}},"email_1":{"type":"string","nullable":true,"description":"Email address of the contact","example":"john.doe@example.com"},"email_2":{"type":"string","nullable":true,"description":"Email address (2) of the contact","example":"john.doe@example.com"},"email_3":{"type":"string","nullable":true,"description":"Email address (3) of the contact","example":"john.doe@example.com"},"phone_number_1":{"type":"string","nullable":true,"description":"Phone number of the contact","example":"555 274 8391"},"phone_number_2":{"type":"string","nullable":true,"description":"Phone number (2) of the contact","example":"555 274 8391"},"phone_number_3":{"type":"string","nullable":true,"description":"Phone number (3) of the contact","example":"555 274 8391"},"website":{"type":"string","nullable":true,"description":"Website of the company","example":"https://john-doe.com"},"linkedin":{"type":"string","nullable":true,"description":"LinkedIn Url the contact","example":"https://linkedin.com/in/johndoe-1234"},"linked_companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"description":"List of companies linked to the contact (for contacts with category \"business-contact\")","example":[{"id":"company-123","name":"Acme 123"}]},"custom_fields":{"type":"array","items":{"type":"object","properties":{"custom_field_id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["custom_field_id","type","value"]},"description":"Custom fields associated with the deal","examples":[[{"custom_field_id":"qualifications","type":"enum","value":"JavaScript, TypeScript, Node.js"},{"custom_field_id":"experience","type":"number","value":"5"}]]},"created_at":{"type":"string","description":"ISO 8601 creation date","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","description":"ISO 8601 last modification date","example":"2024-01-20T14:45:32.123Z"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string","description":"ISO 8601 creation date","example":"2024-01-15T10:30:00.000Z"},"name":{"type":"string"},"type":{"type":"string"},"file":{"type":"object","properties":{"extension":{"type":"string"},"url":{"type":"string"}},"required":["extension","url"]}},"required":["id","created_at","name","type","file"]},"description":"Attachments associated with the contact"}},"required":["id","firstname","lastname","categories","email_1","email_2","email_3","phone_number_1","phone_number_2","phone_number_3","website","linkedin","linked_companies","custom_fields","created_at","updated_at","attachments"]},"PaginatedContactsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"UsersQueryParams":{"type":"object","properties":{"limit":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"created_after":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"created_before":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"updated_after":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"updated_before":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"cursor":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"sort":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: User's creation date</li><li><b>updated_at</b>: User's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"}},"title":"Get Users Query Parameters","description":"Parameters for retrieving users with filtering, sorting, and pagination"},"UserResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the user","example":"user_123"},"email":{"type":"string","format":"email","description":"Email address of the user","example":"john.doe@example.com"},"firstname":{"type":"string","description":"First name of the user","example":"John"},"lastname":{"type":"string","description":"Last name of the user","example":"Doe"},"phone_number_1":{"type":"string","nullable":true,"description":"Phone number of the user","example":"555 274 8391"},"title":{"type":"string","nullable":true,"description":"Title of the user","example":"Wizard"},"avatar_url":{"type":"string","nullable":true,"description":"Avatar url of the user","example":"https://example.com/image.png"},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["key","value"]},"description":"Array of key/value metadata of the user."},"created_at":{"type":"string","description":"ISO 8601 creation date","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","description":"ISO 8601 last modification date","example":"2024-01-20T14:45:32.123Z"}},"required":["id","email","firstname","lastname","phone_number_1","title","avatar_url","metadata","created_at","updated_at"]},"PaginatedUsersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"CompaniesQueryParams":{"type":"object","properties":{"limit":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"created_after":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"created_before":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"updated_after":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"updated_before":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"cursor":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"sort":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Company's creation date</li><li><b>updated_at</b>: Company's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"}},"title":"Get Companies Query Parameters","description":"Parameters for retrieving companies with filtering, sorting, and pagination"},"CompanyResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the company","example":"company-123"},"name":{"type":"string","description":"Name of the company","example":"HireSweet"},"logo_url":{"type":"string","nullable":true,"description":"Logo url of the company","example":"https://example.com/image.png"},"phone_number_1":{"type":"string","nullable":true,"description":"Phone number of the company","example":"555 274 8391"},"website":{"type":"string","nullable":true,"description":"Website of the company","example":"https://hiresweet.com"},"linkedin":{"type":"string","nullable":true,"description":"Linkedin url of the company","example":"https://www.linkedin.com/company/acme-world"},"twitter":{"type":"string","nullable":true,"description":"X/Twitter url of the company","example":"https://x.com/Google"},"street_address":{"type":"string","nullable":true,"description":"Street address of the company","example":"123 Main Street, Suite 100"},"city":{"type":"string","nullable":true,"description":"City where the company is located","example":"San Francisco"},"country":{"type":"string","nullable":true,"description":"Country where the company is located","example":"United States"},"zip_code":{"type":"string","nullable":true,"description":"Postal/ZIP code of the company address","example":"94105"},"description":{"type":"string","nullable":true,"description":"Short description of the company","example":"Acme is a fintech startup that leverages AI-driven risk modeling to provide seamless micro-loans and instant credit solutions to underserved small businesses"},"created_at":{"type":"string","description":"ISO 8601 creation date","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","description":"ISO 8601 last modification date","example":"2024-01-20T14:45:32.123Z"}},"required":["id","name","logo_url","phone_number_1","website","linkedin","twitter","street_address","city","country","zip_code","description","created_at","updated_at"]},"PaginatedCompaniesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"ActivitiesQueryParams":{"type":"object","properties":{"type":{"type":"string","description":"Type of the activity (e.g., invoices)","example":"invoices"},"include_deleted":{"type":"string","description":"Include deleted activities in the results","example":"true"},"limit":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"created_after":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"created_before":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"updated_after":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"updated_before":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"cursor":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"sort":{"type":"string","default":"created_at:desc","description":"<div>\n  Sort order (field:direction).<br/>\n  Field can be:\n  <ul>\n    <li><b>created_at</b>: Activity's creation date</li>\n    <li><b>updated_at</b>: Activity's last update date</li>\n    <li><b>date</b>: Date of the activity</li>\n    <li><b>meeting_start_dates</b>: For calendar meetings, date of the start of the meeting</li>\n  </ul>\n  Direction can be:\n  <ul>\n    <li><b>asc</b>: ascending</li>\n    <li><b>desc</b>: descending</li>\n  </ul>\n</div>","example":"created_at:desc"}},"title":"Get Activities Query Parameters","description":"Parameters for retrieving activities with filtering, sorting, and pagination"},"ActivityResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the activity","example":"activity-123"},"is_deleted":{"type":"boolean","description":"true if the activity has been deleted and is no longer accessible in the app, false otherwise","example":false},"type":{"type":"string","description":"Type of the activity","example":"job_posting"},"subtype":{"type":"string","description":"Subtype of the activity","example":"posted"},"subsubtype":{"type":"string","description":"Subsubtype of the activity","example":"new_job"},"comment":{"type":"string","description":"Optional comment associated with the activity","example":"This is a comment on the activity"},"form_id":{"type":"string","description":"Unique identifier for the form data associated with the activity","example":"activity-form-123"},"form_fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"question":{"type":"object","properties":{"title":{"type":"string"}},"required":["title"]},"answer":{"type":"object","properties":{"value":{"type":"string","nullable":true},"display_value":{"type":"string","nullable":true}},"required":["value","display_value"]}},"required":["id","type","question","answer"]},"description":"Fields with answers of the form linked to the activity"},"custom_activity_id":{"type":"string","description":"Custom identifier for the activity, if applicable","example":"custom-activity-456"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the attachment","example":"attachment-123"},"filename":{"type":"string","description":"Filename of the attachment","example":"document.pdf"},"url":{"type":"string","format":"uri","description":"URL to access the attachment","example":"https://..."}},"required":["id","filename","url"]},"description":"List of attachments associated with the activity","example":[{"id":"attachment-123","filename":"document.pdf","url":"https://..."}]},"created_by":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user who created the activity","example":"user-456"},"email":{"type":"string","format":"email","description":"Email of the user who created the activity","example":"john.doe@hiresweet.com"}},"required":["id","email"],"description":"User who created the activity","example":{"id":"user-456","email":"john.doe@hiresweet.com"}},"owned_by":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user who own the activity","example":"user-456"},"email":{"type":"string","format":"email","description":"Email of the user who own the activity","example":"john.doe@hiresweet.com"}},"required":["id","email"],"description":"User who own the activity","example":{"id":"user-456","email":"john.doe@hiresweet.com"}},"linked_companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"description":"List of companies linked to the activity","example":[{"id":"company-123"}]},"linked_projects":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"description":"List of projects linked to the activity","example":[{"id":"project-123"}]},"linked_contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"categories":{"type":"array","items":{"type":"string","enum":["candidate","business-contact"]}},"roleId":{"type":"string","enum":["candidate","business-contact"]}},"required":["id","categories","roleId"]},"description":"List of contacts linked to the activity","example":[{"id":"contact-123","categories":["candidate"],"roleId":"candidate"}]},"created_at":{"type":"string","description":"ISO 8601 creation date","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","description":"ISO 8601 last modification date","example":"2024-01-20T14:45:32.123Z"}},"required":["id","is_deleted","type","subtype","subsubtype","linked_companies","linked_projects","linked_contacts","created_at","updated_at"]},"PaginatedActivitiesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"JobPostingsQueryParams":{"type":"object","properties":{"published":{"type":"string","description":"Filter by published status","example":"true"},"limit":{"type":"string","description":"Number of results per page (1-100)","example":"20"},"created_after":{"type":"string","description":"Filter results created after this date","example":"2024-01-01T00:00:00.000Z"},"created_before":{"type":"string","description":"Filter results created strictly before this date","example":"2024-01-31T23:59:59.999Z"},"updated_after":{"type":"string","description":"Filter results updated after this date","example":"2024-01-15T00:00:00.000Z"},"updated_before":{"type":"string","description":"Filter results updated strictly before this date","example":"2024-01-20T23:59:59.999Z"},"cursor":{"type":"string","description":"Pagination cursor for next page","example":"eyJ0aW1lc3RhbXAiOiIxNj..."},"sort":{"type":"string","default":"created_at:desc","description":"<div>Sort order (field:direction).<br/>Field can be:<ul><li><b>created_at</b>: Job posting's creation date</li><li><b>updated_at</b>: Job posting's last update date</li></ul>Direction can be:<ul><li><b>asc</b>: ascending</li><li><b>desc</b>: descending</li></ul></div>","example":"created_at:desc"}},"title":"Get Job Postings Query Parameters","description":"Parameters for retrieving job postings with filtering, sorting, and pagination"},"JobPostingResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the job posting","example":"job-posting-abc123"},"published":{"type":"boolean","description":"Whether the job posting is currently published","example":true},"project_id":{"type":"string","description":"Identifier of the associated job offer","example":"job-offer-xyz789"},"content":{"type":"object","properties":{"title":{"type":"string","description":"Job posting title","example":"Senior Software Engineer"},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Section title","example":"About the role"},"content":{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string","description":"Section content","example":"We are looking for..."}},"required":["type","value"]}},"required":["title","content"]},"description":"Description sections"}},"required":["title","sections"],"description":"Job posting content in the default language"},"translations":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"BCP 47 language code","example":"fr"},"title":{"type":"string","description":"Translated job posting title","example":"Ingénieur Logiciel Senior"},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Section title","example":"About the role"},"content":{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string","description":"Section content","example":"We are looking for..."}},"required":["type","value"]}},"required":["title","content"]},"description":"Translated description sections"}},"required":["language","title","sections"]},"description":"Job posting content translated into other available languages"},"created_at":{"type":"string","description":"ISO 8601 creation date","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","description":"ISO 8601 last modification date","example":"2024-01-20T14:45:32.123Z"},"location":{"$ref":"#/components/schemas/Location"},"remote":{"type":"string","enum":["no","occasional-remote","part-time","full-time"],"description":"Remote policy","example":"part-time"},"contractType":{"type":"string","enum":["cdi","cdd","freelance","internship","part-time","interim"],"description":"Contract type","example":"cdi"},"salary":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["free-text"]},"currency":{"type":"string","enum":["EUR","USD","CHF","GBP"]},"freeText":{"type":"string"}},"required":["type","currency","freeText"]},{"type":"object","properties":{"type":{"type":"string","enum":["period-range"]},"currency":{"type":"string","enum":["EUR","USD","CHF","GBP"]},"period":{"type":"string","enum":["year","month","week","day","hour"]},"min":{"type":"number"},"max":{"type":"number"}},"required":["type","currency","period"]}],"description":"Salary","example":{"type":"period-range","currency":"EUR","period":"year","min":65000,"max":75000}},"workload":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["percentage"]},"value":{"type":"number"}},"required":["type","value"]}],"description":"Weekly workload as a percentage of the legal baseline","example":{"type":"percentage","value":80}},"custom_fields":{"type":"array","items":{"type":"object","properties":{"custom_field_id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["custom_field_id","type","value"]},"description":"Custom fields associated with the job posting","example":[{"custom_field_id":"experience","type":"enum","value":"JavaScript, TypeScript"}]}},"required":["id","published","project_id","content","translations","created_at","updated_at","custom_fields"]},"Location":{"type":"object","properties":{"streetNumber":{"type":"string","description":"Street number","example":"242 Rue de Rivoli"},"postalCode":{"type":"string","description":"Postal code","example":"75001"},"city":{"type":"string","description":"City","example":"Paris"},"country":{"type":"string","description":"Country","example":"France"},"region":{"type":"string","description":"Administrative region","example":"Paris"},"latitude":{"type":"number","description":"Latitude","example":48.853495},"longitude":{"type":"number","description":"Longitude","example":2.348392}},"description":"Location of the job"},"PaginatedJobPostingsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/JobPostingResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"The unique identifier of the project":{"type":"string"},"The unique identifier of the user":{"type":"string"}},"parameters":{}},"tags":[]}