For clean Markdown of any page, append .md to the page URL. For a complete documentation index, see https://docs.ivfprovider.com/ivf-agency-ap-is/surrogate/llms.txt. For full documentation content, see https://docs.ivfprovider.com/ivf-agency-ap-is/surrogate/llms-full.txt. # List GET http://localhost:8000/api/surrogates Reference: https://docs.ivfprovider.com/ivf-agency-ap-is/surrogate/list ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/surrogates: get: operationId: list summary: List tags: - subpackage_surrogate parameters: - name: per_page in: query required: false schema: type: integer - name: page in: query required: false schema: type: integer - name: search in: query required: false schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Surrogate_List_Response_200' servers: - url: http://localhost:8000 components: schemas: ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserStatus: type: object properties: id: type: integer name: type: string class: type: string type: type: string translated_name: type: string required: - id - name - class - type - translated_name title: ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserStatus ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUser: type: object properties: id: type: integer agency_id: type: integer full_name: type: string first_name: type: string last_name: type: string middle_name: description: Any type email: type: string format: email unique_id: type: string stripe_customer_id: description: Any type is_premium: type: boolean ip_whitelist_enabled: type: boolean profile_percentage: type: integer reason: description: Any type profile_picture: description: Any type status_id: type: integer status: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserStatus required: - id - agency_id - full_name - first_name - last_name - email - unique_id - is_premium - ip_whitelist_enabled - profile_percentage - status_id - status title: ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUser ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileRace: type: object properties: id: type: integer name: type: string race_value: type: string required: - id - name - race_value title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileRace ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileHeight: type: object properties: id: type: integer name: type: string required: - id - name title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileHeight ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileWeight: type: object properties: id: type: integer name: type: string required: - id - name title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileWeight ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileBloodType: type: object properties: id: type: integer name: type: string required: - id - name title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileBloodType ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileEthnicity: type: object properties: id: type: integer name: type: string required: - id - name title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileEthnicity ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileEducationLevel: type: object properties: id: type: integer name: type: string required: - id - name title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileEducationLevel ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileReligion: type: object properties: id: type: integer name: type: string required: - id - name title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileReligion ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileMaritalStatus: type: object properties: id: type: integer name: type: string required: - id - name title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileMaritalStatus ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfile: type: object properties: user_id: type: integer mobile_phone: type: string mobile_phone_country: type: string home_phone: description: Any type home_phone_country: description: Any type description: type: string date_of_birth: type: string format: date birth_country_id: type: integer race_id: type: integer race: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileRace height_id: type: integer height: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileHeight weight_id: type: integer weight: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileWeight bmi: type: string blood_type_id: type: integer blood_type: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileBloodType ethnicity_id: type: integer ethnicity: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileEthnicity education_level_id: type: integer education_level: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileEducationLevel religion_id: type: integer religion: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileReligion marital_status_id: type: integer marital_status: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfileMaritalStatus occupation: type: string experienced_surrogate: type: string us_citizen: type: string year_of_experience: type: string year_current_relation: type: string partner_occupation: description: Any type biological_children: type: integer health_insurence_carrier: type: string household_smoke: type: string living_conditions: type: string illicit_drugs: type: string carry_twins: type: string cord_blood_banking: type: string compensation: type: string required: - user_id - mobile_phone - mobile_phone_country - description - date_of_birth - birth_country_id - race_id - race - height_id - height - weight_id - weight - bmi - blood_type_id - blood_type - ethnicity_id - ethnicity - education_level_id - education_level - religion_id - religion - marital_status_id - marital_status - occupation - experienced_surrogate - us_citizen - year_of_experience - year_current_relation - biological_children - health_insurence_carrier - household_smoke - living_conditions - illicit_drugs - carry_twins - cord_blood_banking - compensation title: >- ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfile ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsAgency: type: object properties: id: type: integer name: type: string email: type: string format: email mobile_phone: type: string mobile_phone_country: type: string required: - id - name - email - mobile_phone - mobile_phone_country title: ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsAgency ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsAddress: type: object properties: street_address: type: string residence: type: string country_id: type: integer state_id: type: integer city: type: string zip_code: type: string required: - street_address - residence - country_id - state_id - city - zip_code title: ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsAddress ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: user: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUser user_profile: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsUserProfile agency: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsAgency address: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItemsAddress required: - user - user_profile - agency - address title: ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItems ApiSurrogatesGetResponsesContentApplicationJsonSchemaLinks: type: object properties: first: type: string format: uri last: type: string format: uri prev: description: Any type next: description: Any type required: - first - last title: ApiSurrogatesGetResponsesContentApplicationJsonSchemaLinks ApiSurrogatesGetResponsesContentApplicationJsonSchemaMetaLinksItems: type: object properties: url: description: Any type label: type: string active: type: boolean required: - label - active title: ApiSurrogatesGetResponsesContentApplicationJsonSchemaMetaLinksItems ApiSurrogatesGetResponsesContentApplicationJsonSchemaMeta: type: object properties: current_page: type: integer from: type: integer last_page: type: integer links: type: array items: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaMetaLinksItems path: type: string format: uri per_page: type: integer to: type: integer total: type: integer required: - current_page - from - last_page - links - path - per_page - to - total title: ApiSurrogatesGetResponsesContentApplicationJsonSchemaMeta Surrogate_List_Response_200: type: object properties: data: type: array items: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaDataItems links: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaLinks meta: $ref: >- #/components/schemas/ApiSurrogatesGetResponsesContentApplicationJsonSchemaMeta required: - data - links - meta title: Surrogate_List_Response_200 securitySchemes: oauth2Auth: type: http scheme: bearer ``` ## SDK Code Examples ```python Surrogate_List_example import requests url = "http://localhost:8000/api/surrogates" querystring = {"per_page":"10","page":"1","search":""} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Surrogate_List_example const url = 'http://localhost:8000/api/surrogates?per_page=10&page=1&search='; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Surrogate_List_example package main import ( "fmt" "net/http" "io" ) func main() { url := "http://localhost:8000/api/surrogates?per_page=10&page=1&search=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Surrogate_List_example require 'uri' require 'net/http' url = URI("http://localhost:8000/api/surrogates?per_page=10&page=1&search=") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Surrogate_List_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("http://localhost:8000/api/surrogates?per_page=10&page=1&search=") .header("Authorization", "Bearer ") .asString(); ``` ```php Surrogate_List_example request('GET', 'http://localhost:8000/api/surrogates?per_page=10&page=1&search=', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Surrogate_List_example using RestSharp; var client = new RestClient("http://localhost:8000/api/surrogates?per_page=10&page=1&search="); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Surrogate_List_example import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8000/api/surrogates?per_page=10&page=1&search=")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```